1 /* Utilities for ipa analysis.
2 Copyright (C) 2005-2019 Free Software Foundation, Inc.
3 Contributed by Kenneth Zadeck <zadeck@naturalbridge.com>
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 3, or (at your option) any later
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
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
23 #include "coretypes.h"
28 #include "alloc-pool.h"
30 #include "lto-streamer.h"
32 #include "splay-tree.h"
33 #include "ipa-utils.h"
34 #include "symbol-summary.h"
37 #include "ipa-fnsummary.h"
39 /* Debugging function for postorder and inorder code. NOTE is a string
40 that is printed before the nodes are printed. ORDER is an array of
41 cgraph_nodes that has COUNT useful nodes in it. */
44 ipa_print_order (FILE* out
,
46 struct cgraph_node
** order
,
50 fprintf (out
, "\n\n ordered call graph: %s\n", note
);
52 for (i
= count
- 1; i
>= 0; i
--)
60 struct cgraph_node
**stack
;
61 struct cgraph_node
**result
;
64 splay_tree nodes_marked_new
;
69 /* This is an implementation of Tarjan's strongly connected region
70 finder as reprinted in Aho Hopcraft and Ullman's The Design and
71 Analysis of Computer Programs (1975) pages 192-193. This version
72 has been customized for cgraph_nodes. The env parameter is because
73 it is recursive and there are no nested functions here. This
74 function should only be called from itself or
75 ipa_reduced_postorder. ENV is a stack env and would be
76 unnecessary if C had nested functions. V is the node to start
80 searchc (struct searchc_env
* env
, struct cgraph_node
*v
,
81 bool (*ignore_edge
) (struct cgraph_edge
*))
83 struct cgraph_edge
*edge
;
84 struct ipa_dfs_info
*v_info
= (struct ipa_dfs_info
*) v
->aux
;
86 /* mark node as old */
87 v_info
->new_node
= false;
88 splay_tree_remove (env
->nodes_marked_new
, v
->get_uid ());
90 v_info
->dfn_number
= env
->count
;
91 v_info
->low_link
= env
->count
;
93 env
->stack
[(env
->stack_size
)++] = v
;
94 v_info
->on_stack
= true;
96 for (edge
= v
->callees
; edge
; edge
= edge
->next_callee
)
98 struct ipa_dfs_info
* w_info
;
99 enum availability avail
;
100 struct cgraph_node
*w
= edge
->callee
->ultimate_alias_target (&avail
);
102 if (!w
|| (ignore_edge
&& ignore_edge (edge
)))
106 && (avail
>= AVAIL_INTERPOSABLE
))
108 w_info
= (struct ipa_dfs_info
*) w
->aux
;
109 if (w_info
->new_node
)
111 searchc (env
, w
, ignore_edge
);
113 (v_info
->low_link
< w_info
->low_link
) ?
114 v_info
->low_link
: w_info
->low_link
;
117 if ((w_info
->dfn_number
< v_info
->dfn_number
)
118 && (w_info
->on_stack
))
120 (w_info
->dfn_number
< v_info
->low_link
) ?
121 w_info
->dfn_number
: v_info
->low_link
;
126 if (v_info
->low_link
== v_info
->dfn_number
)
128 struct cgraph_node
*last
= NULL
;
129 struct cgraph_node
*x
;
130 struct ipa_dfs_info
*x_info
;
132 x
= env
->stack
[--(env
->stack_size
)];
133 x_info
= (struct ipa_dfs_info
*) x
->aux
;
134 x_info
->on_stack
= false;
135 x_info
->scc_no
= v_info
->dfn_number
;
139 x_info
->next_cycle
= last
;
143 env
->result
[env
->order_pos
++] = x
;
147 env
->result
[env
->order_pos
++] = v
;
151 /* Topsort the call graph by caller relation. Put the result in ORDER.
153 The REDUCE flag is true if you want the cycles reduced to single nodes.
154 You can use ipa_get_nodes_in_cycle to obtain a vector containing all real
155 call graph nodes in a reduced node.
157 Set ALLOW_OVERWRITABLE if nodes with such availability should be included.
158 IGNORE_EDGE, if non-NULL is a hook that may make some edges insignificant
159 for the topological sort. */
162 ipa_reduced_postorder (struct cgraph_node
**order
,
164 bool (*ignore_edge
) (struct cgraph_edge
*))
166 struct cgraph_node
*node
;
167 struct searchc_env env
;
168 splay_tree_node result
;
169 env
.stack
= XCNEWVEC (struct cgraph_node
*, symtab
->cgraph_count
);
173 env
.nodes_marked_new
= splay_tree_new (splay_tree_compare_ints
, 0, 0);
177 FOR_EACH_DEFINED_FUNCTION (node
)
179 enum availability avail
= node
->get_availability ();
181 if (avail
> AVAIL_INTERPOSABLE
182 || avail
== AVAIL_INTERPOSABLE
)
184 /* Reuse the info if it is already there. */
185 struct ipa_dfs_info
*info
= (struct ipa_dfs_info
*) node
->aux
;
187 info
= XCNEW (struct ipa_dfs_info
);
188 info
->new_node
= true;
189 info
->on_stack
= false;
190 info
->next_cycle
= NULL
;
193 splay_tree_insert (env
.nodes_marked_new
,
194 (splay_tree_key
)node
->get_uid (),
195 (splay_tree_value
)node
);
200 result
= splay_tree_min (env
.nodes_marked_new
);
203 node
= (struct cgraph_node
*)result
->value
;
204 searchc (&env
, node
, ignore_edge
);
205 result
= splay_tree_min (env
.nodes_marked_new
);
207 splay_tree_delete (env
.nodes_marked_new
);
210 return env
.order_pos
;
213 /* Deallocate all ipa_dfs_info structures pointed to by the aux pointer of call
217 ipa_free_postorder_info (void)
219 struct cgraph_node
*node
;
220 FOR_EACH_DEFINED_FUNCTION (node
)
222 /* Get rid of the aux information. */
231 /* Get the set of nodes for the cycle in the reduced call graph starting
235 ipa_get_nodes_in_cycle (struct cgraph_node
*node
)
237 vec
<cgraph_node
*> v
= vNULL
;
238 struct ipa_dfs_info
*node_dfs_info
;
242 node_dfs_info
= (struct ipa_dfs_info
*) node
->aux
;
243 node
= node_dfs_info
->next_cycle
;
248 /* Return true iff the CS is an edge within a strongly connected component as
249 computed by ipa_reduced_postorder. */
252 ipa_edge_within_scc (struct cgraph_edge
*cs
)
254 struct ipa_dfs_info
*caller_dfs
= (struct ipa_dfs_info
*) cs
->caller
->aux
;
255 struct ipa_dfs_info
*callee_dfs
;
256 struct cgraph_node
*callee
= cs
->callee
->function_symbol ();
258 callee_dfs
= (struct ipa_dfs_info
*) callee
->aux
;
261 && caller_dfs
->scc_no
== callee_dfs
->scc_no
);
264 struct postorder_stack
266 struct cgraph_node
*node
;
267 struct cgraph_edge
*edge
;
271 /* Fill array order with all nodes with output flag set in the reverse
272 topological order. Return the number of elements in the array.
273 FIXME: While walking, consider aliases, too. */
276 ipa_reverse_postorder (struct cgraph_node
**order
)
278 struct cgraph_node
*node
, *node2
;
281 struct cgraph_edge
*edge
;
283 struct ipa_ref
*ref
= NULL
;
285 struct postorder_stack
*stack
=
286 XCNEWVEC (struct postorder_stack
, symtab
->cgraph_count
);
288 /* We have to deal with cycles nicely, so use a depth first traversal
289 output algorithm. Ignore the fact that some functions won't need
290 to be output and put them into order as well, so we get dependencies
291 right through inline functions. */
292 FOR_EACH_FUNCTION (node
)
294 for (pass
= 0; pass
< 2; pass
++)
295 FOR_EACH_FUNCTION (node
)
298 || (!node
->address_taken
299 && !node
->global
.inlined_to
300 && !node
->alias
&& !node
->thunk
.thunk_p
301 && !node
->only_called_directly_p ())))
304 stack
[stack_size
].node
= node
;
305 stack
[stack_size
].edge
= node
->callers
;
306 stack
[stack_size
].ref
= 0;
307 node
->aux
= (void *)(size_t)1;
308 while (stack_size
>= 0)
313 while (stack
[stack_size
].edge
&& !node2
)
315 edge
= stack
[stack_size
].edge
;
316 node2
= edge
->caller
;
317 stack
[stack_size
].edge
= edge
->next_caller
;
318 /* Break possible cycles involving always-inline
319 functions by ignoring edges from always-inline
320 functions to non-always-inline functions. */
321 if (DECL_DISREGARD_INLINE_LIMITS (edge
->caller
->decl
)
322 && !DECL_DISREGARD_INLINE_LIMITS
323 (edge
->callee
->function_symbol ()->decl
))
326 for (; stack
[stack_size
].node
->iterate_referring (
327 stack
[stack_size
].ref
,
329 stack
[stack_size
].ref
++)
331 if (ref
->use
== IPA_REF_ALIAS
)
332 node2
= dyn_cast
<cgraph_node
*> (ref
->referring
);
338 stack
[++stack_size
].node
= node2
;
339 stack
[stack_size
].edge
= node2
->callers
;
340 stack
[stack_size
].ref
= 0;
341 node2
->aux
= (void *)(size_t)1;
344 order
[order_pos
++] = stack
[stack_size
--].node
;
348 FOR_EACH_FUNCTION (node
)
355 /* Given a memory reference T, will return the variable at the bottom
356 of the access. Unlike get_base_address, this will recurse through
360 get_base_var (tree t
)
362 while (!SSA_VAR_P (t
)
363 && (!CONSTANT_CLASS_P (t
))
364 && TREE_CODE (t
) != LABEL_DECL
365 && TREE_CODE (t
) != FUNCTION_DECL
366 && TREE_CODE (t
) != CONST_DECL
367 && TREE_CODE (t
) != CONSTRUCTOR
)
369 t
= TREE_OPERAND (t
, 0);
374 /* Scale function of calls in NODE by ratio ORIG_COUNT/NODE->count. */
377 scale_ipa_profile_for_fn (struct cgraph_node
*node
, profile_count orig_count
)
379 profile_count to
= node
->count
;
380 profile_count::adjust_for_ipa_scaling (&to
, &orig_count
);
381 struct cgraph_edge
*e
;
383 for (e
= node
->callees
; e
; e
= e
->next_callee
)
384 e
->count
= e
->count
.apply_scale (to
, orig_count
);
385 for (e
= node
->indirect_calls
; e
; e
= e
->next_callee
)
386 e
->count
= e
->count
.apply_scale (to
, orig_count
);
389 /* SRC and DST are going to be merged. Take SRC's profile and merge it into
390 DST so it is not going to be lost. Possibly destroy SRC's body on the way
391 unless PRESERVE_BODY is set. */
394 ipa_merge_profiles (struct cgraph_node
*dst
,
395 struct cgraph_node
*src
,
398 tree oldsrcdecl
= src
->decl
;
399 struct function
*srccfun
, *dstcfun
;
406 if (src
->frequency
< dst
->frequency
)
407 src
->frequency
= dst
->frequency
;
409 /* Time profiles are merged. */
410 if (dst
->tp_first_run
> src
->tp_first_run
&& src
->tp_first_run
)
411 dst
->tp_first_run
= src
->tp_first_run
;
413 if (src
->profile_id
&& !dst
->profile_id
)
414 dst
->profile_id
= src
->profile_id
;
416 /* Merging zero profile to dst is no-op. */
417 if (src
->count
.ipa () == profile_count::zero ())
420 /* FIXME when we merge in unknown profile, we ought to set counts as
422 if (!src
->count
.initialized_p ()
423 || !(src
->count
.ipa () == src
->count
))
425 if (symtab
->dump_file
)
427 fprintf (symtab
->dump_file
, "Merging profiles of %s to %s\n",
428 src
->dump_name (), dst
->dump_name ());
430 profile_count orig_count
= dst
->count
;
432 if (dst
->count
.initialized_p () && dst
->count
.ipa () == dst
->count
)
433 dst
->count
+= src
->count
.ipa ();
435 dst
->count
= src
->count
.ipa ();
437 /* First handle functions with no gimple body. */
438 if (dst
->thunk
.thunk_p
|| dst
->alias
439 || src
->thunk
.thunk_p
|| src
->alias
)
441 scale_ipa_profile_for_fn (dst
, orig_count
);
445 /* This is ugly. We need to get both function bodies into memory.
446 If declaration is merged, we need to duplicate it to be able
447 to load body that is being replaced. This makes symbol table
448 temporarily inconsistent. */
449 if (src
->decl
== dst
->decl
)
451 struct lto_in_decl_state temp
;
452 struct lto_in_decl_state
*state
;
454 /* We are going to move the decl, we want to remove its file decl data.
455 and link these with the new decl. */
456 temp
.fn_decl
= src
->decl
;
457 lto_in_decl_state
**slot
458 = src
->lto_file_data
->function_decl_states
->find_slot (&temp
,
461 src
->lto_file_data
->function_decl_states
->clear_slot (slot
);
464 /* Duplicate the decl and be sure it does not link into body of DST. */
465 src
->decl
= copy_node (src
->decl
);
466 DECL_STRUCT_FUNCTION (src
->decl
) = NULL
;
467 DECL_ARGUMENTS (src
->decl
) = NULL
;
468 DECL_INITIAL (src
->decl
) = NULL
;
469 DECL_RESULT (src
->decl
) = NULL
;
471 /* Associate the decl state with new declaration, so LTO streamer
473 state
->fn_decl
= src
->decl
;
475 = src
->lto_file_data
->function_decl_states
->find_slot (state
, INSERT
);
479 src
->get_untransformed_body ();
480 dst
->get_untransformed_body ();
481 srccfun
= DECL_STRUCT_FUNCTION (src
->decl
);
482 dstcfun
= DECL_STRUCT_FUNCTION (dst
->decl
);
483 if (n_basic_blocks_for_fn (srccfun
)
484 != n_basic_blocks_for_fn (dstcfun
))
486 if (symtab
->dump_file
)
487 fprintf (symtab
->dump_file
,
488 "Giving up; number of basic block mismatch.\n");
491 else if (last_basic_block_for_fn (srccfun
)
492 != last_basic_block_for_fn (dstcfun
))
494 if (symtab
->dump_file
)
495 fprintf (symtab
->dump_file
,
496 "Giving up; last block mismatch.\n");
501 basic_block srcbb
, dstbb
;
503 FOR_ALL_BB_FN (srcbb
, srccfun
)
507 dstbb
= BASIC_BLOCK_FOR_FN (dstcfun
, srcbb
->index
);
510 if (symtab
->dump_file
)
511 fprintf (symtab
->dump_file
,
512 "No matching block for bb %i.\n",
517 if (EDGE_COUNT (srcbb
->succs
) != EDGE_COUNT (dstbb
->succs
))
519 if (symtab
->dump_file
)
520 fprintf (symtab
->dump_file
,
521 "Edge count mistmatch for bb %i.\n",
526 for (i
= 0; i
< EDGE_COUNT (srcbb
->succs
); i
++)
528 edge srce
= EDGE_SUCC (srcbb
, i
);
529 edge dste
= EDGE_SUCC (dstbb
, i
);
530 if (srce
->dest
->index
!= dste
->dest
->index
)
532 if (symtab
->dump_file
)
533 fprintf (symtab
->dump_file
,
534 "Succ edge mistmatch for bb %i.\n",
544 struct cgraph_edge
*e
, *e2
;
545 basic_block srcbb
, dstbb
;
547 /* TODO: merge also statement histograms. */
548 FOR_ALL_BB_FN (srcbb
, srccfun
)
552 dstbb
= BASIC_BLOCK_FOR_FN (dstcfun
, srcbb
->index
);
554 /* Either sum the profiles if both are IPA and not global0, or
555 pick more informative one (that is nonzero IPA if other is
556 uninitialized, guessed or global0). */
557 if (!dstbb
->count
.ipa ().initialized_p ()
558 || (dstbb
->count
.ipa () == profile_count::zero ()
559 && (srcbb
->count
.ipa ().initialized_p ()
560 && !(srcbb
->count
.ipa () == profile_count::zero ()))))
562 dstbb
->count
= srcbb
->count
;
563 for (i
= 0; i
< EDGE_COUNT (srcbb
->succs
); i
++)
565 edge srce
= EDGE_SUCC (srcbb
, i
);
566 edge dste
= EDGE_SUCC (dstbb
, i
);
567 if (srce
->probability
.initialized_p ())
568 dste
->probability
= srce
->probability
;
571 else if (srcbb
->count
.ipa ().initialized_p ()
572 && !(srcbb
->count
.ipa () == profile_count::zero ()))
574 for (i
= 0; i
< EDGE_COUNT (srcbb
->succs
); i
++)
576 edge srce
= EDGE_SUCC (srcbb
, i
);
577 edge dste
= EDGE_SUCC (dstbb
, i
);
579 dste
->probability
* dstbb
->count
.probability_in (dstbb
->count
+ srcbb
->count
)
580 + srce
->probability
* srcbb
->count
.probability_in (dstbb
->count
+ srcbb
->count
);
582 dstbb
->count
+= srcbb
->count
;
586 update_max_bb_count ();
587 compute_function_frequency ();
589 for (e
= dst
->callees
; e
; e
= e
->next_callee
)
593 e
->count
= gimple_bb (e
->call_stmt
)->count
;
595 for (e
= dst
->indirect_calls
, e2
= src
->indirect_calls
; e
;
596 e2
= (e2
? e2
->next_callee
: NULL
), e
= e
->next_callee
)
598 profile_count count
= gimple_bb (e
->call_stmt
)->count
;
599 /* When call is speculative, we need to re-distribute probabilities
600 the same way as they was. This is not really correct because
601 in the other copy the speculation may differ; but probably it
602 is not really worth the effort. */
605 cgraph_edge
*direct
, *indirect
;
606 cgraph_edge
*direct2
= NULL
, *indirect2
= NULL
;
609 e
->speculative_call_info (direct
, indirect
, ref
);
610 gcc_assert (e
== indirect
);
611 if (e2
&& e2
->speculative
)
612 e2
->speculative_call_info (direct2
, indirect2
, ref
);
613 if (indirect
->count
> profile_count::zero ()
614 || direct
->count
> profile_count::zero ())
616 /* We should mismatch earlier if there is no matching
622 "Mismatch in merging indirect edges\n");
624 else if (!e2
->speculative
)
625 indirect
->count
+= e2
->count
;
626 else if (e2
->speculative
)
628 if (DECL_ASSEMBLER_NAME (direct2
->callee
->decl
)
629 != DECL_ASSEMBLER_NAME (direct
->callee
->decl
))
631 if (direct2
->count
>= direct
->count
)
633 direct
->redirect_callee (direct2
->callee
);
634 indirect
->count
+= indirect2
->count
636 direct
->count
= direct2
->count
;
639 indirect
->count
+= indirect2
->count
+ direct2
->count
;
643 direct
->count
+= direct2
->count
;
644 indirect
->count
+= indirect2
->count
;
649 /* At the moment we should have only profile feedback based
650 speculations when merging. */
653 else if (e2
&& e2
->speculative
)
655 cgraph_edge
*direct
, *indirect
;
658 e2
->speculative_call_info (direct
, indirect
, ref
);
660 e
->make_speculative (direct
->callee
, direct
->count
);
666 src
->release_body ();
667 /* Update summary. */
668 compute_fn_summary (dst
, 0);
670 /* We can't update CFG profile, but we can scale IPA profile. CFG
671 will be scaled according to dst->count after IPA passes. */
673 scale_ipa_profile_for_fn (dst
, orig_count
);
674 src
->decl
= oldsrcdecl
;
677 /* Return true if call to DEST is known to be self-recusive call withing FUNC. */
680 recursive_call_p (tree func
, tree dest
)
682 struct cgraph_node
*dest_node
= cgraph_node::get_create (dest
);
683 struct cgraph_node
*cnode
= cgraph_node::get_create (func
);
685 enum availability avail
;
687 gcc_assert (!cnode
->alias
);
688 if (cnode
!= dest_node
->ultimate_alias_target (&avail
))
690 if (avail
>= AVAIL_AVAILABLE
)
692 if (!dest_node
->semantically_equivalent_p (cnode
))
694 /* If there is only one way to call the fuction or we know all of them
695 are semantically equivalent, we still can consider call recursive. */
696 FOR_EACH_ALIAS (cnode
, alias
)
697 if (!dest_node
->semantically_equivalent_p (alias
->referring
))