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 const char * const tls_model_names
[]={"none", "tls-emulated", "tls-real",
40 "tls-global-dynamic", "tls-local-dynamic",
41 "tls-initial-exec", "tls-local-exec"};
43 /* List of hooks triggered on varpool_node events. */
44 struct varpool_node_hook_list
{
45 varpool_node_hook hook
;
47 struct varpool_node_hook_list
*next
;
50 /* List of hooks triggered when a node is removed. */
51 struct varpool_node_hook_list
*first_varpool_node_removal_hook
;
52 /* List of hooks triggered when an variable is inserted. */
53 struct varpool_node_hook_list
*first_varpool_variable_insertion_hook
;
55 /* Register HOOK to be called with DATA on each removed node. */
56 struct varpool_node_hook_list
*
57 varpool_add_node_removal_hook (varpool_node_hook hook
, void *data
)
59 struct varpool_node_hook_list
*entry
;
60 struct varpool_node_hook_list
**ptr
= &first_varpool_node_removal_hook
;
62 entry
= (struct varpool_node_hook_list
*) xmalloc (sizeof (*entry
));
72 /* Remove ENTRY from the list of hooks called on removing nodes. */
74 varpool_remove_node_removal_hook (struct varpool_node_hook_list
*entry
)
76 struct varpool_node_hook_list
**ptr
= &first_varpool_node_removal_hook
;
84 /* Call all node removal hooks. */
86 varpool_call_node_removal_hooks (varpool_node
*node
)
88 struct varpool_node_hook_list
*entry
= first_varpool_node_removal_hook
;
91 entry
->hook (node
, entry
->data
);
96 /* Register HOOK to be called with DATA on each inserted node. */
97 struct varpool_node_hook_list
*
98 varpool_add_variable_insertion_hook (varpool_node_hook hook
, void *data
)
100 struct varpool_node_hook_list
*entry
;
101 struct varpool_node_hook_list
**ptr
= &first_varpool_variable_insertion_hook
;
103 entry
= (struct varpool_node_hook_list
*) xmalloc (sizeof (*entry
));
113 /* Remove ENTRY from the list of hooks called on inserted nodes. */
115 varpool_remove_variable_insertion_hook (struct varpool_node_hook_list
*entry
)
117 struct varpool_node_hook_list
**ptr
= &first_varpool_variable_insertion_hook
;
119 while (*ptr
!= entry
)
125 /* Call all node insertion hooks. */
127 varpool_call_variable_insertion_hooks (varpool_node
*node
)
129 struct varpool_node_hook_list
*entry
= first_varpool_variable_insertion_hook
;
132 entry
->hook (node
, entry
->data
);
137 /* Allocate new callgraph node and insert it into basic data structures. */
140 varpool_create_empty_node (void)
142 varpool_node
*node
= ggc_cleared_alloc
<varpool_node
> ();
143 node
->type
= SYMTAB_VARIABLE
;
147 /* Return varpool node assigned to DECL. Create new one when needed. */
149 varpool_node_for_decl (tree decl
)
151 varpool_node
*node
= varpool_get_node (decl
);
152 gcc_checking_assert (TREE_CODE (decl
) == VAR_DECL
);
156 node
= varpool_create_empty_node ();
158 symtab_register_node (node
);
162 /* Remove node from the varpool. */
164 varpool_remove_node (varpool_node
*node
)
167 varpool_call_node_removal_hooks (node
);
168 symtab_unregister_node (node
);
170 /* Because we remove references from external functions before final compilation,
171 we may end up removing useful constructors.
172 FIXME: We probably want to trace boundaries better. */
173 if (cgraph_state
== CGRAPH_LTO_STREAMING
)
175 else if ((init
= ctor_for_folding (node
->decl
)) == error_mark_node
)
176 varpool_remove_initializer (node
);
178 DECL_INITIAL (node
->decl
) = init
;
182 /* Renove node initializer when it is no longer needed. */
184 varpool_remove_initializer (varpool_node
*node
)
186 if (DECL_INITIAL (node
->decl
)
187 && !DECL_IN_CONSTANT_POOL (node
->decl
)
188 /* Keep vtables for BINFO folding. */
189 && !DECL_VIRTUAL_P (node
->decl
)
190 /* FIXME: http://gcc.gnu.org/PR55395 */
191 && debug_info_level
== DINFO_LEVEL_NONE
192 /* When doing declaration merging we have duplicate
193 entries for given decl. Do not attempt to remove
194 the boides, or we will end up remiving
196 && cgraph_state
!= CGRAPH_LTO_STREAMING
)
197 DECL_INITIAL (node
->decl
) = error_mark_node
;
200 /* Dump given cgraph node. */
202 dump_varpool_node (FILE *f
, varpool_node
*node
)
204 dump_symtab_base (f
, node
);
205 fprintf (f
, " Availability: %s\n",
206 cgraph_function_flags_ready
207 ? cgraph_availability_names
[cgraph_variable_initializer_availability (node
)]
209 fprintf (f
, " Varpool flags:");
210 if (DECL_INITIAL (node
->decl
))
211 fprintf (f
, " initialized");
213 fprintf (f
, " output");
214 if (node
->used_by_single_function
)
215 fprintf (f
, " used-by-single-function");
216 if (TREE_READONLY (node
->decl
))
217 fprintf (f
, " read-only");
218 if (ctor_for_folding (node
->decl
) != error_mark_node
)
219 fprintf (f
, " const-value-known");
221 fprintf (f
, " write-only");
223 fprintf (f
, " %s", tls_model_names
[node
->tls_model
]);
227 /* Dump the variable pool. */
229 dump_varpool (FILE *f
)
233 fprintf (f
, "variable pool:\n\n");
234 FOR_EACH_VARIABLE (node
)
235 dump_varpool_node (f
, node
);
238 /* Dump the variable pool to stderr. */
243 dump_varpool (stderr
);
246 /* Given an assembler name, lookup node. */
248 varpool_node_for_asm (tree asmname
)
250 if (symtab_node
*node
= symtab_node_for_asm (asmname
))
251 return dyn_cast
<varpool_node
*> (node
);
256 /* Return if DECL is constant and its initial value is known (so we can do
257 constant folding using DECL_INITIAL (decl)).
258 Return ERROR_MARK_NODE when value is unknown. */
261 ctor_for_folding (tree decl
)
263 varpool_node
*node
, *real_node
;
266 if (TREE_CODE (decl
) != VAR_DECL
267 && TREE_CODE (decl
) != CONST_DECL
)
268 return error_mark_node
;
270 if (TREE_CODE (decl
) == CONST_DECL
271 || DECL_IN_CONSTANT_POOL (decl
))
272 return DECL_INITIAL (decl
);
274 if (TREE_THIS_VOLATILE (decl
))
275 return error_mark_node
;
277 /* Do not care about automatic variables. Those are never initialized
278 anyway, because gimplifier exapnds the code. */
279 if (!TREE_STATIC (decl
) && !DECL_EXTERNAL (decl
))
281 gcc_assert (!TREE_PUBLIC (decl
));
282 return error_mark_node
;
285 gcc_assert (TREE_CODE (decl
) == VAR_DECL
);
287 node
= varpool_get_node (decl
);
290 real_node
= varpool_variable_node (node
);
291 real_decl
= real_node
->decl
;
296 /* See if we are dealing with alias.
297 In most cases alias is just alternative symbol pointing to a given
298 constructor. This allows us to use interposition rules of DECL
299 constructor of REAL_NODE. However weakrefs are special by being just
300 alternative name of their target (if defined). */
301 if (decl
!= real_decl
)
303 gcc_assert (!DECL_INITIAL (decl
)
304 || DECL_INITIAL (decl
) == error_mark_node
);
305 if (lookup_attribute ("weakref", DECL_ATTRIBUTES (decl
)))
307 node
= varpool_alias_target (node
);
312 /* Vtables are defined by their types and must match no matter of interposition
314 if (DECL_VIRTUAL_P (real_decl
))
316 gcc_checking_assert (TREE_READONLY (real_decl
));
317 if (DECL_INITIAL (real_decl
))
318 return DECL_INITIAL (real_decl
);
321 /* The C++ front end creates VAR_DECLs for vtables of typeinfo
322 classes not defined in the current TU so that it can refer
323 to them from typeinfo objects. Avoid returning NULL_TREE. */
324 gcc_checking_assert (!COMPLETE_TYPE_P (DECL_CONTEXT (real_decl
)));
325 return error_mark_node
;
329 /* If there is no constructor, we have nothing to do. */
330 if (DECL_INITIAL (real_decl
) == error_mark_node
)
331 return error_mark_node
;
333 /* Non-readonly alias of readonly variable is also de-facto readonly,
334 because the variable itself is in readonly section.
335 We also honnor READONLY flag on alias assuming that user knows
337 if (!TREE_READONLY (decl
) && !TREE_READONLY (real_decl
))
338 return error_mark_node
;
340 /* Variables declared 'const' without an initializer
341 have zero as the initializer if they may not be
342 overridden at link or run time. */
343 if (!DECL_INITIAL (real_decl
)
344 && (DECL_EXTERNAL (decl
) || decl_replaceable_p (decl
)))
345 return error_mark_node
;
347 /* Variables declared `const' with an initializer are considered
348 to not be overwritable with different initializer by default.
350 ??? Previously we behaved so for scalar variables but not for array
352 return DECL_INITIAL (real_decl
);
355 /* Add the variable DECL to the varpool.
356 Unlike varpool_finalize_decl function is intended to be used
357 by middle end and allows insertion of new variable at arbitrary point
360 varpool_add_new_variable (tree decl
)
363 varpool_finalize_decl (decl
);
364 node
= varpool_node_for_decl (decl
);
365 varpool_call_variable_insertion_hooks (node
);
366 if (varpool_externally_visible_p (node
))
367 node
->externally_visible
= true;
370 /* Return variable availability. See cgraph.h for description of individual
373 cgraph_variable_initializer_availability (varpool_node
*node
)
375 if (!node
->definition
)
376 return AVAIL_NOT_AVAILABLE
;
377 if (!TREE_PUBLIC (node
->decl
))
378 return AVAIL_AVAILABLE
;
379 if (DECL_IN_CONSTANT_POOL (node
->decl
)
380 || DECL_VIRTUAL_P (node
->decl
))
381 return AVAIL_AVAILABLE
;
382 if (node
->alias
&& node
->weakref
)
384 enum availability avail
;
386 cgraph_variable_initializer_availability
387 (varpool_variable_node (node
, &avail
));
390 /* If the variable can be overwritten, return OVERWRITABLE. Takes
391 care of at least one notable extension - the COMDAT variables
392 used to share template instantiations in C++. */
393 if (decl_replaceable_p (node
->decl
)
394 || DECL_EXTERNAL (node
->decl
))
395 return AVAIL_OVERWRITABLE
;
396 return AVAIL_AVAILABLE
;
400 varpool_analyze_node (varpool_node
*node
)
402 tree decl
= node
->decl
;
404 /* When reading back varpool at LTO time, we re-construct the queue in order
405 to have "needed" list right by inserting all needed nodes into varpool.
406 We however don't want to re-analyze already analyzed nodes. */
409 gcc_assert (!in_lto_p
|| cgraph_function_flags_ready
);
410 /* Compute the alignment early so function body expanders are
411 already informed about increased alignment. */
412 align_variable (decl
, 0);
416 (node
, varpool_get_node (node
->alias_target
));
417 else if (DECL_INITIAL (decl
))
418 record_references_in_initializer (decl
, node
->analyzed
);
419 node
->analyzed
= true;
422 /* Assemble thunks and aliases associated to NODE. */
425 assemble_aliases (varpool_node
*node
)
428 struct ipa_ref
*ref
= NULL
;
430 for (i
= 0; node
->iterate_referring (i
, ref
); i
++)
431 if (ref
->use
== IPA_REF_ALIAS
)
433 varpool_node
*alias
= dyn_cast
<varpool_node
*> (ref
->referring
);
434 do_assemble_alias (alias
->decl
,
435 DECL_ASSEMBLER_NAME (node
->decl
));
436 assemble_aliases (alias
);
440 /* Output one variable, if necessary. Return whether we output it. */
443 varpool_assemble_decl (varpool_node
*node
)
445 tree decl
= node
->decl
;
447 /* Aliases are outout when their target is produced or by
452 /* Constant pool is output from RTL land when the reference
453 survive till this level. */
454 if (DECL_IN_CONSTANT_POOL (decl
) && TREE_ASM_WRITTEN (decl
))
457 /* Decls with VALUE_EXPR should not be in the varpool at all. They
458 are not real variables, but just info for debugging and codegen.
459 Unfortunately at the moment emutls is not updating varpool correctly
460 after turning real vars into value_expr vars. */
461 if (DECL_HAS_VALUE_EXPR_P (decl
)
462 && !targetm
.have_tls
)
465 /* Hard register vars do not need to be output. */
466 if (DECL_HARD_REGISTER (decl
))
469 gcc_checking_assert (!TREE_ASM_WRITTEN (decl
)
470 && TREE_CODE (decl
) == VAR_DECL
471 && !DECL_HAS_VALUE_EXPR_P (decl
));
473 if (!node
->in_other_partition
474 && !DECL_EXTERNAL (decl
))
476 assemble_variable (decl
, 0, 1, 0);
477 gcc_assert (TREE_ASM_WRITTEN (decl
));
478 node
->definition
= true;
479 assemble_aliases (node
);
486 /* Add NODE to queue starting at FIRST.
487 The queue is linked via AUX pointers and terminated by pointer to 1. */
490 enqueue_node (varpool_node
*node
, varpool_node
**first
)
494 gcc_checking_assert (*first
);
499 /* Optimization of function bodies might've rendered some variables as
500 unnecessary so we want to avoid these from being compiled. Re-do
501 reachability starting from variables that are either externally visible
502 or was referred from the asm output routines. */
505 varpool_remove_unreferenced_decls (void)
507 varpool_node
*next
, *node
;
508 varpool_node
*first
= (varpool_node
*)(void *)1;
510 struct ipa_ref
*ref
= NULL
;
511 struct pointer_set_t
*referenced
= pointer_set_create ();
516 if (cgraph_dump_file
)
517 fprintf (cgraph_dump_file
, "Trivially needed variables:");
518 FOR_EACH_DEFINED_VARIABLE (node
)
521 && (!varpool_can_remove_if_no_refs (node
)
522 /* We just expanded all function bodies. See if any of
523 them needed the variable. */
524 || DECL_RTL_SET_P (node
->decl
)))
526 enqueue_node (node
, &first
);
527 if (cgraph_dump_file
)
528 fprintf (cgraph_dump_file
, " %s", node
->asm_name ());
531 while (first
!= (varpool_node
*)(void *)1)
534 first
= (varpool_node
*)first
->aux
;
536 if (node
->same_comdat_group
)
539 for (next
= node
->same_comdat_group
;
541 next
= next
->same_comdat_group
)
543 varpool_node
*vnext
= dyn_cast
<varpool_node
*> (next
);
544 if (vnext
&& vnext
->analyzed
&& !symtab_comdat_local_p (next
))
545 enqueue_node (vnext
, &first
);
548 for (i
= 0; node
->iterate_reference (i
, ref
); i
++)
550 varpool_node
*vnode
= dyn_cast
<varpool_node
*> (ref
->referred
);
552 && !vnode
->in_other_partition
553 && (!DECL_EXTERNAL (ref
->referred
->decl
)
556 enqueue_node (vnode
, &first
);
558 pointer_set_insert (referenced
, node
);
561 if (cgraph_dump_file
)
562 fprintf (cgraph_dump_file
, "\nRemoving variables:");
563 for (node
= varpool_first_defined_variable (); node
; node
= next
)
565 next
= varpool_next_defined_variable (node
);
568 if (cgraph_dump_file
)
569 fprintf (cgraph_dump_file
, " %s", node
->asm_name ());
570 if (pointer_set_contains (referenced
, node
))
571 varpool_remove_initializer (node
);
573 varpool_remove_node (node
);
576 pointer_set_destroy (referenced
);
577 if (cgraph_dump_file
)
578 fprintf (cgraph_dump_file
, "\n");
581 /* For variables in named sections make sure get_variable_section
582 is called before we switch to those sections. Then section
583 conflicts between read-only and read-only requiring relocations
584 sections can be resolved. */
586 varpool_finalize_named_section_flags (varpool_node
*node
)
588 if (!TREE_ASM_WRITTEN (node
->decl
)
590 && !node
->in_other_partition
591 && !DECL_EXTERNAL (node
->decl
)
592 && TREE_CODE (node
->decl
) == VAR_DECL
593 && !DECL_HAS_VALUE_EXPR_P (node
->decl
)
594 && node
->get_section ())
595 get_variable_section (node
->decl
, false);
598 /* Output all variables enqueued to be assembled. */
600 varpool_output_variables (void)
602 bool changed
= false;
608 varpool_remove_unreferenced_decls ();
610 timevar_push (TV_VAROUT
);
612 FOR_EACH_DEFINED_VARIABLE (node
)
613 varpool_finalize_named_section_flags (node
);
615 FOR_EACH_DEFINED_VARIABLE (node
)
616 if (varpool_assemble_decl (node
))
618 timevar_pop (TV_VAROUT
);
622 /* Create a new global variable of type TYPE. */
624 add_new_static_var (tree type
)
627 varpool_node
*new_node
;
629 new_decl
= create_tmp_var_raw (type
, NULL
);
630 DECL_NAME (new_decl
) = create_tmp_var_name (NULL
);
631 TREE_READONLY (new_decl
) = 0;
632 TREE_STATIC (new_decl
) = 1;
633 TREE_USED (new_decl
) = 1;
634 DECL_CONTEXT (new_decl
) = NULL_TREE
;
635 DECL_ABSTRACT (new_decl
) = 0;
636 lang_hooks
.dup_lang_specific_decl (new_decl
);
637 new_node
= varpool_node_for_decl (new_decl
);
638 varpool_finalize_decl (new_decl
);
640 return new_node
->decl
;
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_create_variable_alias (tree alias
, tree decl
)
649 varpool_node
*alias_node
;
651 gcc_assert (TREE_CODE (decl
) == VAR_DECL
);
652 gcc_assert (TREE_CODE (alias
) == VAR_DECL
);
653 alias_node
= varpool_node_for_decl (alias
);
654 alias_node
->alias
= true;
655 alias_node
->definition
= true;
656 alias_node
->alias_target
= decl
;
657 if (lookup_attribute ("weakref", DECL_ATTRIBUTES (alias
)) != NULL
)
658 alias_node
->weakref
= true;
662 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
663 Extra name aliases are output whenever DECL is output. */
666 varpool_extra_name_alias (tree alias
, tree decl
)
668 varpool_node
*alias_node
;
670 #ifndef ASM_OUTPUT_DEF
671 /* If aliases aren't supported by the assembler, fail. */
674 alias_node
= varpool_create_variable_alias (alias
, decl
);
675 alias_node
->cpp_implicit_alias
= true;
677 /* Extra name alias mechanizm creates aliases really late
678 via DECL_ASSEMBLER_NAME mechanizm.
679 This is unfortunate because they are not going through the
680 standard channels. Ensure they get output. */
681 if (cpp_implicit_aliases_done
)
682 symtab_resolve_alias (alias_node
,
683 varpool_node_for_decl (decl
));
687 /* Call calback on NODE and aliases associated to NODE.
688 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
692 varpool_for_node_and_aliases (varpool_node
*node
,
693 bool (*callback
) (varpool_node
*, void *),
695 bool include_overwritable
)
698 struct ipa_ref
*ref
= NULL
;
700 if (callback (node
, data
))
702 for (i
= 0; node
->iterate_referring (i
, ref
); i
++)
703 if (ref
->use
== IPA_REF_ALIAS
)
705 varpool_node
*alias
= dyn_cast
<varpool_node
*> (ref
->referring
);
706 if (include_overwritable
707 || cgraph_variable_initializer_availability (alias
) > AVAIL_OVERWRITABLE
)
708 if (varpool_for_node_and_aliases (alias
, callback
, data
,
709 include_overwritable
))