1 /* Callgraph handling code.
2 Copyright (C) 2003-2019 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"
30 #include "lto-streamer.h"
34 #include "omp-offload.h"
36 #include "stringpool.h"
39 const char * const tls_model_names
[]={"none", "emulated",
40 "global-dynamic", "local-dynamic",
41 "initial-exec", "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 /* Register HOOK to be called with DATA on each removed node. */
51 varpool_node_hook_list
*
52 symbol_table::add_varpool_removal_hook (varpool_node_hook hook
, void *data
)
54 varpool_node_hook_list
*entry
;
55 varpool_node_hook_list
**ptr
= &m_first_varpool_removal_hook
;
57 entry
= (varpool_node_hook_list
*) xmalloc (sizeof (*entry
));
67 /* Remove ENTRY from the list of hooks called on removing nodes. */
69 symbol_table::remove_varpool_removal_hook (varpool_node_hook_list
*entry
)
71 varpool_node_hook_list
**ptr
= &m_first_varpool_removal_hook
;
79 /* Call all node removal hooks. */
81 symbol_table::call_varpool_removal_hooks (varpool_node
*node
)
83 varpool_node_hook_list
*entry
= m_first_varpool_removal_hook
;
86 entry
->hook (node
, entry
->data
);
91 /* Register HOOK to be called with DATA on each inserted node. */
92 varpool_node_hook_list
*
93 symbol_table::add_varpool_insertion_hook (varpool_node_hook hook
, void *data
)
95 varpool_node_hook_list
*entry
;
96 varpool_node_hook_list
**ptr
= &m_first_varpool_insertion_hook
;
98 entry
= (varpool_node_hook_list
*) xmalloc (sizeof (*entry
));
108 /* Remove ENTRY from the list of hooks called on inserted nodes. */
110 symbol_table::remove_varpool_insertion_hook (varpool_node_hook_list
*entry
)
112 varpool_node_hook_list
**ptr
= &m_first_varpool_insertion_hook
;
114 while (*ptr
!= entry
)
120 /* Call all node insertion hooks. */
122 symbol_table::call_varpool_insertion_hooks (varpool_node
*node
)
124 varpool_node_hook_list
*entry
= m_first_varpool_insertion_hook
;
127 entry
->hook (node
, entry
->data
);
132 /* Allocate new callgraph node and insert it into basic data structures. */
135 varpool_node::create_empty (void)
137 varpool_node
*node
= ggc_cleared_alloc
<varpool_node
> ();
138 node
->type
= SYMTAB_VARIABLE
;
142 /* Return varpool node assigned to DECL. Create new one when needed. */
144 varpool_node::get_create (tree decl
)
146 varpool_node
*node
= varpool_node::get (decl
);
147 gcc_checking_assert (VAR_P (decl
));
151 node
= varpool_node::create_empty ();
154 if ((flag_openacc
|| flag_openmp
)
155 && lookup_attribute ("omp declare target", DECL_ATTRIBUTES (decl
)))
157 node
->offloadable
= 1;
158 if (ENABLE_OFFLOADING
&& !DECL_EXTERNAL (decl
))
160 g
->have_offload
= true;
162 vec_safe_push (offload_vars
, decl
);
166 node
->register_symbol ();
170 /* Remove variable from symbol table. */
173 varpool_node::remove (void)
175 symtab
->call_varpool_removal_hooks (this);
178 lto_free_function_in_decl_state_for_node (this);
179 lto_file_data
= NULL
;
182 /* When streaming we can have multiple nodes associated with decl. */
183 if (symtab
->state
== LTO_STREAMING
)
185 /* Keep constructor when it may be used for folding. We remove
186 references to external variables before final compilation. */
187 else if (DECL_INITIAL (decl
) && DECL_INITIAL (decl
) != error_mark_node
188 && !ctor_useable_for_folding_p ())
189 remove_initializer ();
195 /* Remove node initializer when it is no longer needed. */
197 varpool_node::remove_initializer (void)
199 if (DECL_INITIAL (decl
)
200 && !DECL_IN_CONSTANT_POOL (decl
)
201 /* Keep vtables for BINFO folding. */
202 && !DECL_VIRTUAL_P (decl
)
203 /* FIXME: http://gcc.gnu.org/PR55395 */
204 && debug_info_level
== DINFO_LEVEL_NONE
205 /* When doing declaration merging we have duplicate
206 entries for given decl. Do not attempt to remove
207 the bodies, or we will end up removing
209 && symtab
->state
!= LTO_STREAMING
)
210 DECL_INITIAL (decl
) = error_mark_node
;
213 /* Dump given varpool node to F. */
215 varpool_node::dump (FILE *f
)
218 fprintf (f
, " Availability: %s\n",
219 symtab
->function_flags_ready
220 ? cgraph_availability_names
[get_availability ()]
222 fprintf (f
, " Varpool flags:");
223 if (DECL_INITIAL (decl
))
224 fprintf (f
, " initialized");
226 fprintf (f
, " output");
227 if (used_by_single_function
)
228 fprintf (f
, " used-by-single-function");
229 if (TREE_READONLY (decl
))
230 fprintf (f
, " read-only");
231 if (ctor_useable_for_folding_p ())
232 fprintf (f
, " const-value-known");
234 fprintf (f
, " write-only");
236 fprintf (f
, " tls-%s", tls_model_names
[tls_model
]);
241 /* Dump given varpool node to stderr. */
242 void varpool_node::debug (void)
244 varpool_node::dump (stderr
);
247 /* Dump the variable pool to F. */
249 varpool_node::dump_varpool (FILE *f
)
253 fprintf (f
, "variable pool:\n\n");
254 FOR_EACH_VARIABLE (node
)
258 /* Dump the variable pool to stderr. */
261 varpool_node::debug_varpool (void)
263 dump_varpool (stderr
);
266 /* Given an assembler name, lookup node. */
268 varpool_node::get_for_asmname (tree asmname
)
270 if (symtab_node
*node
= symtab_node::get_for_asmname (asmname
))
271 return dyn_cast
<varpool_node
*> (node
);
276 /* When doing LTO, read variable's constructor from disk if
277 it is not already present. */
280 varpool_node::get_constructor (void)
282 lto_file_decl_data
*file_data
;
283 const char *data
, *name
;
286 if (DECL_INITIAL (decl
) != error_mark_node
289 return DECL_INITIAL (decl
);
291 timevar_push (TV_IPA_LTO_CTORS_IN
);
293 file_data
= lto_file_data
;
294 name
= IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (decl
));
296 /* We may have renamed the declaration, e.g., a static function. */
297 name
= lto_get_decl_name_mapping (file_data
, name
);
298 struct lto_in_decl_state
*decl_state
299 = lto_get_function_in_decl_state (file_data
, decl
);
301 data
= lto_get_section_data (file_data
, LTO_section_function_body
,
302 name
, order
- file_data
->order_base
,
303 &len
, decl_state
->compressed
);
305 fatal_error (input_location
, "%s: section %s.%d is missing",
306 file_data
->file_name
,
307 name
, order
- file_data
->order_base
);
310 fprintf (stderr
, " in:%s", IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (decl
)));
311 lto_input_variable_constructor (file_data
, this, data
);
312 gcc_assert (DECL_INITIAL (decl
) != error_mark_node
);
313 lto_stats
.num_function_bodies
++;
314 lto_free_section_data (file_data
, LTO_section_function_body
, name
,
315 data
, len
, decl_state
->compressed
);
316 lto_free_function_in_decl_state_for_node (this);
317 timevar_pop (TV_IPA_LTO_CTORS_IN
);
318 return DECL_INITIAL (decl
);
321 /* Return true if variable has constructor that can be used for folding. */
324 varpool_node::ctor_useable_for_folding_p (void)
326 varpool_node
*real_node
= this;
328 if (real_node
->alias
&& real_node
->definition
)
329 real_node
= ultimate_alias_target ();
331 if (TREE_CODE (decl
) == CONST_DECL
332 || DECL_IN_CONSTANT_POOL (decl
))
334 if (TREE_THIS_VOLATILE (decl
))
337 /* Avoid attempts to load constructors that was not streamed. */
338 if (in_lto_p
&& DECL_INITIAL (real_node
->decl
) == error_mark_node
339 && real_node
->body_removed
)
342 /* If we do not have a constructor, we can't use it. */
343 if (DECL_INITIAL (real_node
->decl
) == error_mark_node
344 && !real_node
->lto_file_data
)
347 /* Vtables are defined by their types and must match no matter of interposition
349 if (DECL_VIRTUAL_P (decl
))
351 /* The C++ front end creates VAR_DECLs for vtables of typeinfo
352 classes not defined in the current TU so that it can refer
353 to them from typeinfo objects. Avoid returning NULL_TREE. */
354 return DECL_INITIAL (real_node
->decl
) != NULL
;
357 /* Alias of readonly variable is also readonly, since the variable is stored
358 in readonly memory. We also accept readonly aliases of non-readonly
359 locations assuming that user knows what he is asking for. */
360 if (!TREE_READONLY (decl
) && !TREE_READONLY (real_node
->decl
))
363 /* Variables declared 'const' without an initializer
364 have zero as the initializer if they may not be
365 overridden at link or run time.
367 It is actually requirement for C++ compiler to optimize const variables
368 consistently. As a GNU extension, do not enforce this rule for user defined
369 weak variables, so we support interposition on:
370 static const int dummy = 0;
371 extern const int foo __attribute__((__weak__, __alias__("dummy")));
373 if ((!DECL_INITIAL (real_node
->decl
)
374 || (DECL_WEAK (decl
) && !DECL_COMDAT (decl
)))
375 && (DECL_EXTERNAL (decl
) || decl_replaceable_p (decl
)))
378 /* Variables declared `const' with an initializer are considered
379 to not be overwritable with different initializer by default.
381 ??? Previously we behaved so for scalar variables but not for array
386 /* If DECLARATION is constant variable and its initial value is known
387 (so we can do constant folding), return its constructor (DECL_INITIAL).
388 This may be an expression or NULL when DECL is initialized to 0.
389 Return ERROR_MARK_NODE otherwise.
391 In LTO this may actually trigger reading the constructor from disk.
392 For this reason varpool_ctor_useable_for_folding_p should be used when
393 the actual constructor value is not needed. */
396 ctor_for_folding (tree decl
)
398 varpool_node
*node
, *real_node
;
401 if (!VAR_P (decl
) && TREE_CODE (decl
) != CONST_DECL
)
402 return error_mark_node
;
404 if (TREE_CODE (decl
) == CONST_DECL
405 || DECL_IN_CONSTANT_POOL (decl
))
406 return DECL_INITIAL (decl
);
408 if (TREE_THIS_VOLATILE (decl
))
409 return error_mark_node
;
411 /* Do not care about automatic variables. Those are never initialized
412 anyway, because gimplifier expands the code. */
413 if (!TREE_STATIC (decl
) && !DECL_EXTERNAL (decl
))
415 gcc_assert (!TREE_PUBLIC (decl
));
416 return error_mark_node
;
419 gcc_assert (VAR_P (decl
));
421 real_node
= node
= varpool_node::get (decl
);
424 real_node
= node
->ultimate_alias_target ();
425 real_decl
= real_node
->decl
;
430 /* See if we are dealing with alias.
431 In most cases alias is just alternative symbol pointing to a given
432 constructor. This allows us to use interposition rules of DECL
433 constructor of REAL_NODE. However weakrefs are special by being just
434 alternative name of their target (if defined). */
435 if (decl
!= real_decl
)
437 gcc_assert (!DECL_INITIAL (decl
)
438 || (node
->alias
&& node
->get_alias_target () == real_node
)
439 || DECL_INITIAL (decl
) == error_mark_node
);
440 while (node
->transparent_alias
&& node
->analyzed
)
442 node
= node
->get_alias_target ();
447 if ((!DECL_VIRTUAL_P (real_decl
)
448 || DECL_INITIAL (real_decl
) == error_mark_node
449 || !DECL_INITIAL (real_decl
))
450 && (!node
|| !node
->ctor_useable_for_folding_p ()))
451 return error_mark_node
;
453 /* OK, we can return constructor. See if we need to fetch it from disk
455 if (DECL_INITIAL (real_decl
) != error_mark_node
457 return DECL_INITIAL (real_decl
);
458 return real_node
->get_constructor ();
461 /* Add the variable DECL to the varpool.
462 Unlike finalize_decl function is intended to be used
463 by middle end and allows insertion of new variable at arbitrary point
466 varpool_node::add (tree decl
)
469 varpool_node::finalize_decl (decl
);
470 node
= varpool_node::get_create (decl
);
471 symtab
->call_varpool_insertion_hooks (node
);
472 if (node
->externally_visible_p ())
473 node
->externally_visible
= true;
474 if (lookup_attribute ("no_reorder", DECL_ATTRIBUTES (decl
)))
475 node
->no_reorder
= 1;
478 /* Return variable availability. See cgraph.h for description of individual
481 varpool_node::get_availability (symtab_node
*ref
)
484 return AVAIL_NOT_AVAILABLE
;
485 if (!TREE_PUBLIC (decl
))
486 return AVAIL_AVAILABLE
;
487 if (DECL_IN_CONSTANT_POOL (decl
)
488 || DECL_VIRTUAL_P (decl
))
489 return AVAIL_AVAILABLE
;
490 if (transparent_alias
&& definition
)
492 enum availability avail
;
494 ultimate_alias_target (&avail
, ref
);
497 /* If this is a reference from symbol itself and there are no aliases, we
498 may be sure that the symbol was not interposed by something else because
499 the symbol itself would be unreachable otherwise. */
500 if ((this == ref
&& !has_aliases_p ())
501 || (ref
&& get_comdat_group ()
502 && get_comdat_group () == ref
->get_comdat_group ()))
503 return AVAIL_AVAILABLE
;
504 /* If the variable can be overwritten, return OVERWRITABLE. Takes
505 care of at least one notable extension - the COMDAT variables
506 used to share template instantiations in C++. */
507 if (decl_replaceable_p (decl
)
508 || DECL_EXTERNAL (decl
))
509 return AVAIL_INTERPOSABLE
;
510 return AVAIL_AVAILABLE
;
514 varpool_node::analyze (void)
516 /* When reading back varpool at LTO time, we re-construct the queue in order
517 to have "needed" list right by inserting all needed nodes into varpool.
518 We however don't want to re-analyze already analyzed nodes. */
521 gcc_assert (!in_lto_p
|| symtab
->function_flags_ready
);
522 /* Compute the alignment early so function body expanders are
523 already informed about increased alignment. */
524 align_variable (decl
, 0);
527 resolve_alias (varpool_node::get (alias_target
));
528 else if (DECL_INITIAL (decl
))
529 record_references_in_initializer (decl
, analyzed
);
533 /* Assemble thunks and aliases associated to varpool node. */
536 varpool_node::assemble_aliases (void)
540 FOR_EACH_ALIAS (this, ref
)
542 varpool_node
*alias
= dyn_cast
<varpool_node
*> (ref
->referring
);
544 do_assemble_symver (alias
->decl
,
545 DECL_ASSEMBLER_NAME (decl
));
546 else if (!alias
->transparent_alias
)
547 do_assemble_alias (alias
->decl
,
548 DECL_ASSEMBLER_NAME (decl
));
549 alias
->assemble_aliases ();
553 /* Output one variable, if necessary. Return whether we output it. */
556 varpool_node::assemble_decl (void)
558 /* Aliases are output when their target is produced or by
563 /* Constant pool is output from RTL land when the reference
564 survive till this level. */
565 if (DECL_IN_CONSTANT_POOL (decl
) && TREE_ASM_WRITTEN (decl
))
568 /* Decls with VALUE_EXPR should not be in the varpool at all. They
569 are not real variables, but just info for debugging and codegen.
570 Unfortunately at the moment emutls is not updating varpool correctly
571 after turning real vars into value_expr vars. */
572 if (DECL_HAS_VALUE_EXPR_P (decl
)
573 && !targetm
.have_tls
)
576 /* Hard register vars do not need to be output. */
577 if (DECL_HARD_REGISTER (decl
))
580 gcc_checking_assert (!TREE_ASM_WRITTEN (decl
)
582 && !DECL_HAS_VALUE_EXPR_P (decl
));
584 if (!in_other_partition
585 && !DECL_EXTERNAL (decl
))
588 assemble_variable (decl
, 0, 1, 0);
589 gcc_assert (TREE_ASM_WRITTEN (decl
));
590 gcc_assert (definition
);
592 /* After the parser has generated debugging information, augment
593 this information with any new location/etc information that may
594 have become available after the compilation proper. */
595 debug_hooks
->late_global_decl (decl
);
602 /* Add NODE to queue starting at FIRST.
603 The queue is linked via AUX pointers and terminated by pointer to 1. */
606 enqueue_node (varpool_node
*node
, varpool_node
**first
)
610 gcc_checking_assert (*first
);
615 /* Optimization of function bodies might've rendered some variables as
616 unnecessary so we want to avoid these from being compiled. Re-do
617 reachability starting from variables that are either externally visible
618 or was referred from the asm output routines. */
621 symbol_table::remove_unreferenced_decls (void)
623 varpool_node
*next
, *node
;
624 varpool_node
*first
= (varpool_node
*)(void *)1;
627 hash_set
<varpool_node
*> referenced
;
633 fprintf (dump_file
, "Trivially needed variables:");
634 FOR_EACH_DEFINED_VARIABLE (node
)
637 && (!node
->can_remove_if_no_refs_p ()
638 /* We just expanded all function bodies. See if any of
639 them needed the variable. */
640 || DECL_RTL_SET_P (node
->decl
)))
642 enqueue_node (node
, &first
);
644 fprintf (dump_file
, " %s", node
->asm_name ());
647 while (first
!= (varpool_node
*)(void *)1)
650 first
= (varpool_node
*)first
->aux
;
652 if (node
->same_comdat_group
)
655 for (next
= node
->same_comdat_group
;
657 next
= next
->same_comdat_group
)
659 varpool_node
*vnext
= dyn_cast
<varpool_node
*> (next
);
660 if (vnext
&& vnext
->analyzed
&& !next
->comdat_local_p ())
661 enqueue_node (vnext
, &first
);
664 for (i
= 0; node
->iterate_reference (i
, ref
); i
++)
666 varpool_node
*vnode
= dyn_cast
<varpool_node
*> (ref
->referred
);
668 && !vnode
->in_other_partition
669 && (!DECL_EXTERNAL (ref
->referred
->decl
)
672 enqueue_node (vnode
, &first
);
675 referenced
.add (vnode
);
676 while (vnode
&& vnode
->alias
&& vnode
->definition
)
678 vnode
= vnode
->get_alias_target ();
679 referenced
.add (vnode
);
685 fprintf (dump_file
, "\nRemoving variables:");
686 for (node
= first_defined_variable (); node
; node
= next
)
688 next
= next_defined_variable (node
);
689 if (!node
->aux
&& !node
->no_reorder
)
692 fprintf (dump_file
, " %s", node
->asm_name ());
693 if (referenced
.contains(node
))
694 node
->remove_initializer ();
701 fprintf (dump_file
, "\n");
704 /* For variables in named sections make sure get_variable_section
705 is called before we switch to those sections. Then section
706 conflicts between read-only and read-only requiring relocations
707 sections can be resolved. */
709 varpool_node::finalize_named_section_flags (void)
711 if (!TREE_ASM_WRITTEN (decl
)
713 && !in_other_partition
714 && !DECL_EXTERNAL (decl
)
716 && !DECL_HAS_VALUE_EXPR_P (decl
)
718 get_variable_section (decl
, false);
721 /* Output all variables enqueued to be assembled. */
723 symbol_table::output_variables (void)
725 bool changed
= false;
731 remove_unreferenced_decls ();
733 timevar_push (TV_VAROUT
);
735 FOR_EACH_DEFINED_VARIABLE (node
)
737 /* Handled in output_in_order. */
738 if (node
->no_reorder
)
741 node
->finalize_named_section_flags ();
744 /* There is a similar loop in output_in_order. Please keep them in sync. */
745 FOR_EACH_VARIABLE (node
)
747 /* Handled in output_in_order. */
748 if (node
->no_reorder
)
750 if (DECL_HARD_REGISTER (node
->decl
)
751 || DECL_HAS_VALUE_EXPR_P (node
->decl
))
753 if (node
->definition
)
754 changed
|= node
->assemble_decl ();
756 assemble_undefined_decl (node
->decl
);
758 timevar_pop (TV_VAROUT
);
762 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
763 Extra name aliases are output whenever DECL is output. */
766 varpool_node::create_alias (tree alias
, tree decl
)
768 varpool_node
*alias_node
;
770 gcc_assert (VAR_P (decl
));
771 gcc_assert (VAR_P (alias
));
772 alias_node
= varpool_node::get_create (alias
);
773 alias_node
->alias
= true;
774 alias_node
->definition
= true;
775 alias_node
->alias_target
= decl
;
776 if (lookup_attribute ("weakref", DECL_ATTRIBUTES (alias
)) != NULL
)
777 alias_node
->weakref
= alias_node
->transparent_alias
= true;
781 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
782 Extra name aliases are output whenever DECL is output. */
785 varpool_node::create_extra_name_alias (tree alias
, tree decl
)
787 varpool_node
*alias_node
;
789 /* If aliases aren't supported by the assembler, fail. */
790 if (!TARGET_SUPPORTS_ALIASES
)
793 alias_node
= varpool_node::create_alias (alias
, decl
);
794 alias_node
->cpp_implicit_alias
= true;
796 /* Extra name alias mechanism creates aliases really late
797 via DECL_ASSEMBLER_NAME mechanism.
798 This is unfortunate because they are not going through the
799 standard channels. Ensure they get output. */
800 if (symtab
->cpp_implicit_aliases_done
)
801 alias_node
->resolve_alias (varpool_node::get_create (decl
));
805 /* Worker for call_for_symbol_and_aliases. */
808 varpool_node::call_for_symbol_and_aliases_1 (bool (*callback
) (varpool_node
*,
811 bool include_overwritable
)
815 FOR_EACH_ALIAS (this, ref
)
817 varpool_node
*alias
= dyn_cast
<varpool_node
*> (ref
->referring
);
818 if (include_overwritable
819 || alias
->get_availability () > AVAIL_INTERPOSABLE
)
820 if (alias
->call_for_symbol_and_aliases (callback
, data
,
821 include_overwritable
))