1 /* Callgraph handling code.
2 Copyright (C) 2003-2014 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 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 "langhooks.h"
29 #include "diagnostic-core.h"
35 #include "gimple-expr.h"
37 #include "pointer-set.h"
39 /* List of hooks triggered on varpool_node events. */
40 struct varpool_node_hook_list
{
41 varpool_node_hook hook
;
43 struct varpool_node_hook_list
*next
;
46 /* List of hooks triggered when a node is removed. */
47 struct varpool_node_hook_list
*first_varpool_node_removal_hook
;
48 /* List of hooks triggered when an variable is inserted. */
49 struct varpool_node_hook_list
*first_varpool_variable_insertion_hook
;
51 /* Register HOOK to be called with DATA on each removed node. */
52 struct varpool_node_hook_list
*
53 varpool_add_node_removal_hook (varpool_node_hook hook
, void *data
)
55 struct varpool_node_hook_list
*entry
;
56 struct varpool_node_hook_list
**ptr
= &first_varpool_node_removal_hook
;
58 entry
= (struct varpool_node_hook_list
*) xmalloc (sizeof (*entry
));
68 /* Remove ENTRY from the list of hooks called on removing nodes. */
70 varpool_remove_node_removal_hook (struct varpool_node_hook_list
*entry
)
72 struct varpool_node_hook_list
**ptr
= &first_varpool_node_removal_hook
;
80 /* Call all node removal hooks. */
82 varpool_call_node_removal_hooks (varpool_node
*node
)
84 struct varpool_node_hook_list
*entry
= first_varpool_node_removal_hook
;
87 entry
->hook (node
, entry
->data
);
92 /* Register HOOK to be called with DATA on each inserted node. */
93 struct varpool_node_hook_list
*
94 varpool_add_variable_insertion_hook (varpool_node_hook hook
, void *data
)
96 struct varpool_node_hook_list
*entry
;
97 struct varpool_node_hook_list
**ptr
= &first_varpool_variable_insertion_hook
;
99 entry
= (struct varpool_node_hook_list
*) xmalloc (sizeof (*entry
));
109 /* Remove ENTRY from the list of hooks called on inserted nodes. */
111 varpool_remove_variable_insertion_hook (struct varpool_node_hook_list
*entry
)
113 struct varpool_node_hook_list
**ptr
= &first_varpool_variable_insertion_hook
;
115 while (*ptr
!= entry
)
121 /* Call all node insertion hooks. */
123 varpool_call_variable_insertion_hooks (varpool_node
*node
)
125 struct varpool_node_hook_list
*entry
= first_varpool_variable_insertion_hook
;
128 entry
->hook (node
, entry
->data
);
133 /* Allocate new callgraph node and insert it into basic data structures. */
136 varpool_create_empty_node (void)
138 varpool_node
*node
= ggc_alloc_cleared_varpool_node ();
139 node
->type
= SYMTAB_VARIABLE
;
143 /* Return varpool node assigned to DECL. Create new one when needed. */
145 varpool_node_for_decl (tree decl
)
147 varpool_node
*node
= varpool_get_node (decl
);
148 gcc_checking_assert (TREE_CODE (decl
) == VAR_DECL
);
152 node
= varpool_create_empty_node ();
154 symtab_register_node (node
);
158 /* Remove node from the varpool. */
160 varpool_remove_node (varpool_node
*node
)
163 varpool_call_node_removal_hooks (node
);
164 symtab_unregister_node (node
);
166 /* Because we remove references from external functions before final compilation,
167 we may end up removing useful constructors.
168 FIXME: We probably want to trace boundaries better. */
169 if (cgraph_state
== CGRAPH_LTO_STREAMING
)
171 else if ((init
= ctor_for_folding (node
->decl
)) == error_mark_node
)
172 varpool_remove_initializer (node
);
174 DECL_INITIAL (node
->decl
) = init
;
178 /* Renove node initializer when it is no longer needed. */
180 varpool_remove_initializer (varpool_node
*node
)
182 if (DECL_INITIAL (node
->decl
)
183 && !DECL_IN_CONSTANT_POOL (node
->decl
)
184 /* Keep vtables for BINFO folding. */
185 && !DECL_VIRTUAL_P (node
->decl
)
186 /* FIXME: http://gcc.gnu.org/PR55395 */
187 && debug_info_level
== DINFO_LEVEL_NONE
188 /* When doing declaration merging we have duplicate
189 entries for given decl. Do not attempt to remove
190 the boides, or we will end up remiving
192 && cgraph_state
!= CGRAPH_LTO_STREAMING
)
193 DECL_INITIAL (node
->decl
) = error_mark_node
;
196 /* Dump given cgraph node. */
198 dump_varpool_node (FILE *f
, varpool_node
*node
)
200 dump_symtab_base (f
, node
);
201 fprintf (f
, " Availability: %s\n",
202 cgraph_function_flags_ready
203 ? cgraph_availability_names
[cgraph_variable_initializer_availability (node
)]
205 fprintf (f
, " Varpool flags:");
206 if (DECL_INITIAL (node
->decl
))
207 fprintf (f
, " initialized");
209 fprintf (f
, " output");
210 if (TREE_READONLY (node
->decl
))
211 fprintf (f
, " read-only");
212 if (ctor_for_folding (node
->decl
) != error_mark_node
)
213 fprintf (f
, " const-value-known");
217 /* Dump the variable pool. */
219 dump_varpool (FILE *f
)
223 fprintf (f
, "variable pool:\n\n");
224 FOR_EACH_VARIABLE (node
)
225 dump_varpool_node (f
, node
);
228 /* Dump the variable pool to stderr. */
233 dump_varpool (stderr
);
236 /* Given an assembler name, lookup node. */
238 varpool_node_for_asm (tree asmname
)
240 if (symtab_node
*node
= symtab_node_for_asm (asmname
))
241 return dyn_cast
<varpool_node
*> (node
);
246 /* Return if DECL is constant and its initial value is known (so we can do
247 constant folding using DECL_INITIAL (decl)).
248 Return ERROR_MARK_NODE when value is unknown. */
251 ctor_for_folding (tree decl
)
253 varpool_node
*node
, *real_node
;
256 if (TREE_CODE (decl
) != VAR_DECL
257 && TREE_CODE (decl
) != CONST_DECL
)
258 return error_mark_node
;
260 if (TREE_CODE (decl
) == CONST_DECL
261 || DECL_IN_CONSTANT_POOL (decl
))
262 return DECL_INITIAL (decl
);
264 if (TREE_THIS_VOLATILE (decl
))
265 return error_mark_node
;
267 /* Do not care about automatic variables. Those are never initialized
268 anyway, because gimplifier exapnds the code. */
269 if (!TREE_STATIC (decl
) && !DECL_EXTERNAL (decl
))
271 gcc_assert (!TREE_PUBLIC (decl
));
272 return error_mark_node
;
275 gcc_assert (TREE_CODE (decl
) == VAR_DECL
);
277 node
= varpool_get_node (decl
);
280 real_node
= varpool_variable_node (node
);
281 real_decl
= real_node
->decl
;
286 /* See if we are dealing with alias.
287 In most cases alias is just alternative symbol pointing to a given
288 constructor. This allows us to use interposition rules of DECL
289 constructor of REAL_NODE. However weakrefs are special by being just
290 alternative name of their target (if defined). */
291 if (decl
!= real_decl
)
293 gcc_assert (!DECL_INITIAL (decl
)
294 || DECL_INITIAL (decl
) == error_mark_node
);
295 if (lookup_attribute ("weakref", DECL_ATTRIBUTES (decl
)))
297 node
= varpool_alias_target (node
);
302 /* Vtables are defined by their types and must match no matter of interposition
304 if (DECL_VIRTUAL_P (real_decl
))
306 gcc_checking_assert (TREE_READONLY (real_decl
));
307 return DECL_INITIAL (real_decl
);
310 /* If there is no constructor, we have nothing to do. */
311 if (DECL_INITIAL (real_decl
) == error_mark_node
)
312 return error_mark_node
;
314 /* Non-readonly alias of readonly variable is also de-facto readonly,
315 because the variable itself is in readonly section.
316 We also honnor READONLY flag on alias assuming that user knows
318 if (!TREE_READONLY (decl
) && !TREE_READONLY (real_decl
))
319 return error_mark_node
;
321 /* Variables declared 'const' without an initializer
322 have zero as the initializer if they may not be
323 overridden at link or run time. */
324 if (!DECL_INITIAL (real_decl
)
325 && (DECL_EXTERNAL (decl
) || decl_replaceable_p (decl
)))
326 return error_mark_node
;
328 /* Variables declared `const' with an initializer are considered
329 to not be overwritable with different initializer by default.
331 ??? Previously we behaved so for scalar variables but not for array
333 return DECL_INITIAL (real_decl
);
336 /* Add the variable DECL to the varpool.
337 Unlike varpool_finalize_decl function is intended to be used
338 by middle end and allows insertion of new variable at arbitrary point
341 varpool_add_new_variable (tree decl
)
344 varpool_finalize_decl (decl
);
345 node
= varpool_node_for_decl (decl
);
346 varpool_call_variable_insertion_hooks (node
);
347 if (varpool_externally_visible_p (node
))
348 node
->externally_visible
= true;
351 /* Return variable availability. See cgraph.h for description of individual
354 cgraph_variable_initializer_availability (varpool_node
*node
)
356 gcc_assert (cgraph_function_flags_ready
);
357 if (!node
->definition
)
358 return AVAIL_NOT_AVAILABLE
;
359 if (!TREE_PUBLIC (node
->decl
))
360 return AVAIL_AVAILABLE
;
361 if (DECL_IN_CONSTANT_POOL (node
->decl
)
362 || DECL_VIRTUAL_P (node
->decl
))
363 return AVAIL_AVAILABLE
;
364 if (node
->alias
&& node
->weakref
)
366 enum availability avail
;
368 cgraph_variable_initializer_availability
369 (varpool_variable_node (node
, &avail
));
372 /* If the variable can be overwritten, return OVERWRITABLE. Takes
373 care of at least one notable extension - the COMDAT variables
374 used to share template instantiations in C++. */
375 if (decl_replaceable_p (node
->decl
)
376 || DECL_EXTERNAL (node
->decl
))
377 return AVAIL_OVERWRITABLE
;
378 return AVAIL_AVAILABLE
;
382 varpool_analyze_node (varpool_node
*node
)
384 tree decl
= node
->decl
;
386 /* When reading back varpool at LTO time, we re-construct the queue in order
387 to have "needed" list right by inserting all needed nodes into varpool.
388 We however don't want to re-analyze already analyzed nodes. */
391 gcc_assert (!in_lto_p
|| cgraph_function_flags_ready
);
392 /* Compute the alignment early so function body expanders are
393 already informed about increased alignment. */
394 align_variable (decl
, 0);
398 (node
, varpool_get_node (node
->alias_target
));
399 else if (DECL_INITIAL (decl
))
400 record_references_in_initializer (decl
, node
->analyzed
);
401 node
->analyzed
= true;
404 /* Assemble thunks and aliases associated to NODE. */
407 assemble_aliases (varpool_node
*node
)
411 for (i
= 0; ipa_ref_list_referring_iterate (&node
->ref_list
, i
, ref
); i
++)
412 if (ref
->use
== IPA_REF_ALIAS
)
414 varpool_node
*alias
= ipa_ref_referring_varpool_node (ref
);
415 do_assemble_alias (alias
->decl
,
416 DECL_ASSEMBLER_NAME (node
->decl
));
417 assemble_aliases (alias
);
421 /* Output one variable, if necessary. Return whether we output it. */
424 varpool_assemble_decl (varpool_node
*node
)
426 tree decl
= node
->decl
;
428 /* Aliases are outout when their target is produced or by
433 /* Constant pool is output from RTL land when the reference
434 survive till this level. */
435 if (DECL_IN_CONSTANT_POOL (decl
) && TREE_ASM_WRITTEN (decl
))
438 /* Decls with VALUE_EXPR should not be in the varpool at all. They
439 are not real variables, but just info for debugging and codegen.
440 Unfortunately at the moment emutls is not updating varpool correctly
441 after turning real vars into value_expr vars. */
442 if (DECL_HAS_VALUE_EXPR_P (decl
)
443 && !targetm
.have_tls
)
446 /* Hard register vars do not need to be output. */
447 if (DECL_HARD_REGISTER (decl
))
450 gcc_checking_assert (!TREE_ASM_WRITTEN (decl
)
451 && TREE_CODE (decl
) == VAR_DECL
452 && !DECL_HAS_VALUE_EXPR_P (decl
));
454 if (!node
->in_other_partition
455 && !DECL_EXTERNAL (decl
))
457 assemble_variable (decl
, 0, 1, 0);
458 gcc_assert (TREE_ASM_WRITTEN (decl
));
459 node
->definition
= true;
460 assemble_aliases (node
);
467 /* Add NODE to queue starting at FIRST.
468 The queue is linked via AUX pointers and terminated by pointer to 1. */
471 enqueue_node (varpool_node
*node
, varpool_node
**first
)
475 gcc_checking_assert (*first
);
480 /* Optimization of function bodies might've rendered some variables as
481 unnecessary so we want to avoid these from being compiled. Re-do
482 reachability starting from variables that are either externally visible
483 or was referred from the asm output routines. */
486 varpool_remove_unreferenced_decls (void)
488 varpool_node
*next
, *node
;
489 varpool_node
*first
= (varpool_node
*)(void *)1;
492 struct pointer_set_t
*referenced
= pointer_set_create ();
497 if (cgraph_dump_file
)
498 fprintf (cgraph_dump_file
, "Trivially needed variables:");
499 FOR_EACH_DEFINED_VARIABLE (node
)
502 && (!varpool_can_remove_if_no_refs (node
)
503 /* We just expanded all function bodies. See if any of
504 them needed the variable. */
505 || DECL_RTL_SET_P (node
->decl
)))
507 enqueue_node (node
, &first
);
508 if (cgraph_dump_file
)
509 fprintf (cgraph_dump_file
, " %s", node
->asm_name ());
512 while (first
!= (varpool_node
*)(void *)1)
515 first
= (varpool_node
*)first
->aux
;
517 if (node
->same_comdat_group
)
520 for (next
= node
->same_comdat_group
;
522 next
= next
->same_comdat_group
)
524 varpool_node
*vnext
= dyn_cast
<varpool_node
*> (next
);
525 if (vnext
&& vnext
->analyzed
&& !symtab_comdat_local_p (next
))
526 enqueue_node (vnext
, &first
);
529 for (i
= 0; ipa_ref_list_reference_iterate (&node
->ref_list
, i
, ref
); i
++)
531 varpool_node
*vnode
= dyn_cast
<varpool_node
*> (ref
->referred
);
533 && !vnode
->in_other_partition
534 && (!DECL_EXTERNAL (ref
->referred
->decl
)
537 enqueue_node (vnode
, &first
);
539 pointer_set_insert (referenced
, node
);
542 if (cgraph_dump_file
)
543 fprintf (cgraph_dump_file
, "\nRemoving variables:");
544 for (node
= varpool_first_defined_variable (); node
; node
= next
)
546 next
= varpool_next_defined_variable (node
);
549 if (cgraph_dump_file
)
550 fprintf (cgraph_dump_file
, " %s", node
->asm_name ());
551 if (pointer_set_contains (referenced
, node
))
552 varpool_remove_initializer (node
);
554 varpool_remove_node (node
);
557 pointer_set_destroy (referenced
);
558 if (cgraph_dump_file
)
559 fprintf (cgraph_dump_file
, "\n");
562 /* For variables in named sections make sure get_variable_section
563 is called before we switch to those sections. Then section
564 conflicts between read-only and read-only requiring relocations
565 sections can be resolved. */
567 varpool_finalize_named_section_flags (varpool_node
*node
)
569 if (!TREE_ASM_WRITTEN (node
->decl
)
571 && !node
->in_other_partition
572 && !DECL_EXTERNAL (node
->decl
)
573 && TREE_CODE (node
->decl
) == VAR_DECL
574 && !DECL_HAS_VALUE_EXPR_P (node
->decl
)
575 && DECL_SECTION_NAME (node
->decl
))
576 get_variable_section (node
->decl
, false);
579 /* Output all variables enqueued to be assembled. */
581 varpool_output_variables (void)
583 bool changed
= false;
589 varpool_remove_unreferenced_decls ();
591 timevar_push (TV_VAROUT
);
593 FOR_EACH_DEFINED_VARIABLE (node
)
594 varpool_finalize_named_section_flags (node
);
596 FOR_EACH_DEFINED_VARIABLE (node
)
597 if (varpool_assemble_decl (node
))
599 timevar_pop (TV_VAROUT
);
603 /* Create a new global variable of type TYPE. */
605 add_new_static_var (tree type
)
608 varpool_node
*new_node
;
610 new_decl
= create_tmp_var_raw (type
, NULL
);
611 DECL_NAME (new_decl
) = create_tmp_var_name (NULL
);
612 TREE_READONLY (new_decl
) = 0;
613 TREE_STATIC (new_decl
) = 1;
614 TREE_USED (new_decl
) = 1;
615 DECL_CONTEXT (new_decl
) = NULL_TREE
;
616 DECL_ABSTRACT (new_decl
) = 0;
617 lang_hooks
.dup_lang_specific_decl (new_decl
);
618 new_node
= varpool_node_for_decl (new_decl
);
619 varpool_finalize_decl (new_decl
);
621 return new_node
->decl
;
624 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
625 Extra name aliases are output whenever DECL is output. */
628 varpool_create_variable_alias (tree alias
, tree decl
)
630 varpool_node
*alias_node
;
632 gcc_assert (TREE_CODE (decl
) == VAR_DECL
);
633 gcc_assert (TREE_CODE (alias
) == VAR_DECL
);
634 alias_node
= varpool_node_for_decl (alias
);
635 alias_node
->alias
= true;
636 alias_node
->definition
= true;
637 alias_node
->alias_target
= decl
;
638 if (lookup_attribute ("weakref", DECL_ATTRIBUTES (alias
)) != NULL
)
639 alias_node
->weakref
= true;
643 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
644 Extra name aliases are output whenever DECL is output. */
647 varpool_extra_name_alias (tree alias
, tree decl
)
649 varpool_node
*alias_node
;
651 #ifndef ASM_OUTPUT_DEF
652 /* If aliases aren't supported by the assembler, fail. */
655 alias_node
= varpool_create_variable_alias (alias
, decl
);
656 alias_node
->cpp_implicit_alias
= true;
658 /* Extra name alias mechanizm creates aliases really late
659 via DECL_ASSEMBLER_NAME mechanizm.
660 This is unfortunate because they are not going through the
661 standard channels. Ensure they get output. */
662 if (cpp_implicit_aliases_done
)
663 symtab_resolve_alias (alias_node
,
664 varpool_node_for_decl (decl
));
668 /* Call calback on NODE and aliases associated to NODE.
669 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
673 varpool_for_node_and_aliases (varpool_node
*node
,
674 bool (*callback
) (varpool_node
*, void *),
676 bool include_overwritable
)
681 if (callback (node
, data
))
683 for (i
= 0; ipa_ref_list_referring_iterate (&node
->ref_list
, i
, ref
); i
++)
684 if (ref
->use
== IPA_REF_ALIAS
)
686 varpool_node
*alias
= ipa_ref_referring_varpool_node (ref
);
687 if (include_overwritable
688 || cgraph_variable_initializer_availability (alias
) > AVAIL_OVERWRITABLE
)
689 if (varpool_for_node_and_aliases (alias
, callback
, data
,
690 include_overwritable
))