1 /* Callgraph handling code.
2 Copyright (C) 2003-2024 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"
38 #include "tree-pass.h"
40 const char * const tls_model_names
[]={"none", "emulated",
41 "global-dynamic", "local-dynamic",
42 "initial-exec", "local-exec"};
44 /* List of hooks triggered on varpool_node events. */
45 struct varpool_node_hook_list
{
46 varpool_node_hook hook
;
48 struct varpool_node_hook_list
*next
;
51 /* Register HOOK to be called with DATA on each removed node. */
52 varpool_node_hook_list
*
53 symbol_table::add_varpool_removal_hook (varpool_node_hook hook
, void *data
)
55 varpool_node_hook_list
*entry
;
56 varpool_node_hook_list
**ptr
= &m_first_varpool_removal_hook
;
58 entry
= (varpool_node_hook_list
*) xmalloc (sizeof (*entry
));
68 /* Remove ENTRY from the list of hooks called on removing nodes. */
70 symbol_table::remove_varpool_removal_hook (varpool_node_hook_list
*entry
)
72 varpool_node_hook_list
**ptr
= &m_first_varpool_removal_hook
;
80 /* Call all node removal hooks. */
82 symbol_table::call_varpool_removal_hooks (varpool_node
*node
)
84 varpool_node_hook_list
*entry
= m_first_varpool_removal_hook
;
87 entry
->hook (node
, entry
->data
);
92 /* Register HOOK to be called with DATA on each inserted node. */
93 varpool_node_hook_list
*
94 symbol_table::add_varpool_insertion_hook (varpool_node_hook hook
, void *data
)
96 varpool_node_hook_list
*entry
;
97 varpool_node_hook_list
**ptr
= &m_first_varpool_insertion_hook
;
99 entry
= (varpool_node_hook_list
*) xmalloc (sizeof (*entry
));
109 /* Remove ENTRY from the list of hooks called on inserted nodes. */
111 symbol_table::remove_varpool_insertion_hook (varpool_node_hook_list
*entry
)
113 varpool_node_hook_list
**ptr
= &m_first_varpool_insertion_hook
;
115 while (*ptr
!= entry
)
121 /* Call all node insertion hooks. */
123 symbol_table::call_varpool_insertion_hooks (varpool_node
*node
)
125 varpool_node_hook_list
*entry
= m_first_varpool_insertion_hook
;
128 entry
->hook (node
, entry
->data
);
133 /* Allocate new callgraph node and insert it into basic data structures. */
136 varpool_node::create_empty (void)
138 return new (ggc_alloc
<varpool_node
> ()) varpool_node ();
141 /* Return varpool node assigned to DECL. Create new one when needed. */
143 varpool_node::get_create (tree decl
)
145 varpool_node
*node
= varpool_node::get (decl
);
146 gcc_checking_assert (VAR_P (decl
));
150 node
= varpool_node::create_empty ();
153 if ((flag_openacc
|| flag_openmp
)
154 && lookup_attribute ("omp declare target", DECL_ATTRIBUTES (decl
)))
156 node
->offloadable
= 1;
157 if (ENABLE_OFFLOADING
&& !DECL_EXTERNAL (decl
))
159 g
->have_offload
= true;
161 vec_safe_push (offload_vars
, decl
);
165 node
->register_symbol ();
169 /* Remove variable from symbol table. */
172 varpool_node::remove (void)
174 symtab
->call_varpool_removal_hooks (this);
177 lto_free_function_in_decl_state_for_node (this);
178 lto_file_data
= NULL
;
181 /* When streaming we can have multiple nodes associated with decl. */
182 if (symtab
->state
== LTO_STREAMING
)
184 /* Keep constructor when it may be used for folding. We remove
185 references to external variables before final compilation. */
186 else if (DECL_INITIAL (decl
) && DECL_INITIAL (decl
) != error_mark_node
187 && !ctor_useable_for_folding_p ())
188 remove_initializer ();
194 /* Remove node initializer when it is no longer needed. */
196 varpool_node::remove_initializer (void)
198 if (DECL_INITIAL (decl
)
199 && !DECL_IN_CONSTANT_POOL (decl
)
200 /* Keep vtables for BINFO folding. */
201 && !DECL_VIRTUAL_P (decl
)
202 /* FIXME: http://gcc.gnu.org/PR55395 */
203 && debug_info_level
== DINFO_LEVEL_NONE
204 /* When doing declaration merging we have duplicate
205 entries for given decl. Do not attempt to remove
206 the bodies, or we will end up removing
208 && symtab
->state
!= LTO_STREAMING
)
209 DECL_INITIAL (decl
) = error_mark_node
;
212 /* Dump given varpool node to F. */
214 varpool_node::dump (FILE *f
)
217 fprintf (f
, " Availability: %s\n",
218 symtab
->function_flags_ready
219 ? cgraph_availability_names
[get_availability ()]
221 fprintf (f
, " Varpool flags:");
222 if (DECL_INITIAL (decl
))
223 fprintf (f
, " initialized");
225 fprintf (f
, " output");
226 if (used_by_single_function
)
227 fprintf (f
, " used-by-single-function");
228 if (TREE_READONLY (decl
))
229 fprintf (f
, " read-only");
230 if (ctor_useable_for_folding_p ())
231 fprintf (f
, " const-value-known");
233 fprintf (f
, " write-only");
235 fprintf (f
, " tls-%s", tls_model_names
[tls_model
]);
240 /* Dump given varpool node to stderr. */
241 void varpool_node::debug (void)
243 varpool_node::dump (stderr
);
246 /* Dump the variable pool to F. */
248 varpool_node::dump_varpool (FILE *f
)
252 fprintf (f
, "variable pool:\n\n");
253 FOR_EACH_VARIABLE (node
)
257 /* Dump the variable pool to stderr. */
260 varpool_node::debug_varpool (void)
262 dump_varpool (stderr
);
265 /* Given an assembler name, lookup node. */
267 varpool_node::get_for_asmname (tree asmname
)
269 if (symtab_node
*node
= symtab_node::get_for_asmname (asmname
))
270 return dyn_cast
<varpool_node
*> (node
);
275 /* When doing LTO, read variable's constructor from disk if
276 it is not already present. */
279 varpool_node::get_constructor (void)
281 lto_file_decl_data
*file_data
;
282 const char *data
, *name
;
285 if (DECL_INITIAL (decl
) != error_mark_node
288 return DECL_INITIAL (decl
);
290 timevar_push (TV_IPA_LTO_CTORS_IN
);
292 file_data
= lto_file_data
;
293 name
= IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (decl
));
295 /* We may have renamed the declaration, e.g., a static function. */
296 name
= lto_get_decl_name_mapping (file_data
, name
);
297 struct lto_in_decl_state
*decl_state
298 = lto_get_function_in_decl_state (file_data
, decl
);
300 data
= lto_get_section_data (file_data
, LTO_section_function_body
,
301 name
, order
- file_data
->order_base
,
302 &len
, decl_state
->compressed
);
304 fatal_error (input_location
, "%s: section %s.%d is missing",
305 file_data
->file_name
,
306 name
, order
- file_data
->order_base
);
309 fprintf (stderr
, " in:%s", IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (decl
)));
310 lto_input_variable_constructor (file_data
, this, data
);
311 gcc_assert (DECL_INITIAL (decl
) != error_mark_node
);
312 lto_stats
.num_function_bodies
++;
313 lto_free_section_data (file_data
, LTO_section_function_body
, name
,
314 data
, len
, decl_state
->compressed
);
315 lto_free_function_in_decl_state_for_node (this);
316 timevar_pop (TV_IPA_LTO_CTORS_IN
);
317 return DECL_INITIAL (decl
);
320 /* Return true if variable has constructor that can be used for folding. */
323 varpool_node::ctor_useable_for_folding_p (void)
325 varpool_node
*real_node
= this;
327 if (real_node
->alias
&& real_node
->definition
)
328 real_node
= ultimate_alias_target ();
330 if (TREE_CODE (decl
) == CONST_DECL
331 || DECL_IN_CONSTANT_POOL (decl
))
333 if (TREE_THIS_VOLATILE (decl
))
336 /* Avoid attempts to load constructors that was not streamed. */
337 if (in_lto_p
&& DECL_INITIAL (real_node
->decl
) == error_mark_node
338 && real_node
->body_removed
)
341 /* If we do not have a constructor, we can't use it. */
342 if (DECL_INITIAL (real_node
->decl
) == error_mark_node
343 && !real_node
->lto_file_data
)
346 /* Vtables are defined by their types and must match no matter of interposition
348 if (DECL_VIRTUAL_P (decl
))
350 /* The C++ front end creates VAR_DECLs for vtables of typeinfo
351 classes not defined in the current TU so that it can refer
352 to them from typeinfo objects. Avoid returning NULL_TREE. */
353 return DECL_INITIAL (real_node
->decl
) != NULL
;
356 /* An alias of a read-only variable is also read-only, since the variable
357 is stored in read-only memory. We also accept read-only aliases of
358 non-read-only locations assuming that the user knows what he is asking
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
) && !in_other_partition
)
376 || decl_replaceable_p (decl
, semantic_interposition
)))
379 /* Variables declared `const' with an initializer are considered
380 to not be overwritable with different initializer by default.
382 ??? Previously we behaved so for scalar variables but not for array
387 /* If DECLARATION is constant variable and its initial value is known
388 (so we can do constant folding), return its constructor (DECL_INITIAL).
389 This may be an expression or NULL when DECL is initialized to 0.
390 Return ERROR_MARK_NODE otherwise.
392 In LTO this may actually trigger reading the constructor from disk.
393 For this reason varpool_ctor_useable_for_folding_p should be used when
394 the actual constructor value is not needed. */
397 ctor_for_folding (tree decl
)
399 varpool_node
*node
, *real_node
;
402 if (!VAR_P (decl
) && TREE_CODE (decl
) != CONST_DECL
)
403 return error_mark_node
;
405 if (TREE_CODE (decl
) == CONST_DECL
406 || DECL_IN_CONSTANT_POOL (decl
))
407 return DECL_INITIAL (decl
);
409 if (TREE_THIS_VOLATILE (decl
))
410 return error_mark_node
;
412 /* Do not care about automatic variables. Those are never initialized
413 anyway, because gimplifier expands the code. */
414 if (!TREE_STATIC (decl
) && !DECL_EXTERNAL (decl
))
416 gcc_assert (!TREE_PUBLIC (decl
));
417 /* Unless this is called during FE folding. */
419 && (cfun
->curr_properties
& (PROP_gimple
| PROP_rtl
)) == 0
420 && TREE_READONLY (decl
)
421 && !TREE_SIDE_EFFECTS (decl
)
422 && DECL_INITIAL (decl
))
423 return DECL_INITIAL (decl
);
424 return error_mark_node
;
427 gcc_assert (VAR_P (decl
));
429 real_node
= node
= varpool_node::get (decl
);
432 real_node
= node
->ultimate_alias_target ();
433 real_decl
= real_node
->decl
;
438 /* See if we are dealing with alias.
439 In most cases alias is just alternative symbol pointing to a given
440 constructor. This allows us to use interposition rules of DECL
441 constructor of REAL_NODE. However weakrefs are special by being just
442 alternative name of their target (if defined). */
443 if (decl
!= real_decl
)
445 gcc_assert (!DECL_INITIAL (decl
)
446 || (node
->alias
&& node
->get_alias_target () == real_node
)
447 || DECL_INITIAL (decl
) == error_mark_node
);
448 while (node
->transparent_alias
&& node
->analyzed
)
450 node
= node
->get_alias_target ();
455 if ((!DECL_VIRTUAL_P (real_decl
)
456 || DECL_INITIAL (real_decl
) == error_mark_node
457 || !DECL_INITIAL (real_decl
))
458 && (!node
|| !node
->ctor_useable_for_folding_p ()))
459 return error_mark_node
;
461 /* OK, we can return constructor. See if we need to fetch it from disk
463 if (DECL_INITIAL (real_decl
) != error_mark_node
465 return DECL_INITIAL (real_decl
);
466 return real_node
->get_constructor ();
469 /* Add the variable DECL to the varpool.
470 Unlike finalize_decl function is intended to be used
471 by middle end and allows insertion of new variable at arbitrary point
474 varpool_node::add (tree decl
)
477 varpool_node::finalize_decl (decl
);
478 node
= varpool_node::get_create (decl
);
479 symtab
->call_varpool_insertion_hooks (node
);
480 if (node
->externally_visible_p ())
481 node
->externally_visible
= true;
482 if (lookup_attribute ("no_reorder", DECL_ATTRIBUTES (decl
)))
483 node
->no_reorder
= 1;
486 /* Return variable availability. See cgraph.h for description of individual
489 varpool_node::get_availability (symtab_node
*ref
)
491 if (!definition
&& !in_other_partition
)
492 return AVAIL_NOT_AVAILABLE
;
493 if (!TREE_PUBLIC (decl
))
494 return AVAIL_AVAILABLE
;
495 if (DECL_IN_CONSTANT_POOL (decl
)
496 || DECL_VIRTUAL_P (decl
))
497 return AVAIL_AVAILABLE
;
498 if (transparent_alias
&& definition
)
500 enum availability avail
;
502 ultimate_alias_target (&avail
, ref
);
505 /* If this is a reference from symbol itself and there are no aliases, we
506 may be sure that the symbol was not interposed by something else because
507 the symbol itself would be unreachable otherwise. */
508 if ((this == ref
&& !has_aliases_p ())
509 || (ref
&& get_comdat_group ()
510 && get_comdat_group () == ref
->get_comdat_group ()))
511 return AVAIL_AVAILABLE
;
512 /* If the variable can be overwritten, return OVERWRITABLE. Takes
513 care of at least one notable extension - the COMDAT variables
514 used to share template instantiations in C++. */
515 if (decl_replaceable_p (decl
, semantic_interposition
)
516 || (DECL_EXTERNAL (decl
) && !in_other_partition
))
517 return AVAIL_INTERPOSABLE
;
518 return AVAIL_AVAILABLE
;
522 varpool_node::analyze (void)
524 /* When reading back varpool at LTO time, we re-construct the queue in order
525 to have "needed" list right by inserting all needed nodes into varpool.
526 We however don't want to re-analyze already analyzed nodes. */
529 gcc_assert (!in_lto_p
|| symtab
->function_flags_ready
);
530 /* Compute the alignment early so function body expanders are
531 already informed about increased alignment. */
532 align_variable (decl
, 0);
535 resolve_alias (varpool_node::get (alias_target
));
536 else if (DECL_INITIAL (decl
))
537 record_references_in_initializer (decl
, analyzed
);
541 /* Assemble thunks and aliases associated to varpool node. */
544 varpool_node::assemble_aliases (void)
548 FOR_EACH_ALIAS (this, ref
)
550 varpool_node
*alias
= dyn_cast
<varpool_node
*> (ref
->referring
);
552 do_assemble_symver (alias
->decl
,
553 DECL_ASSEMBLER_NAME (decl
));
554 else if (!alias
->transparent_alias
)
555 do_assemble_alias (alias
->decl
,
556 DECL_ASSEMBLER_NAME (decl
));
557 alias
->assemble_aliases ();
561 /* Output one variable, if necessary. Return whether we output it. */
564 varpool_node::assemble_decl (void)
566 /* Aliases are output when their target is produced or by
571 /* Constant pool is output from RTL land when the reference
572 survive till this level. */
573 if (DECL_IN_CONSTANT_POOL (decl
) && TREE_ASM_WRITTEN (decl
))
576 /* Decls with VALUE_EXPR should not be in the varpool at all. They
577 are not real variables, but just info for debugging and codegen.
578 Unfortunately at the moment emutls is not updating varpool correctly
579 after turning real vars into value_expr vars. */
580 if (DECL_HAS_VALUE_EXPR_P (decl
)
581 && !targetm
.have_tls
)
584 /* Hard register vars do not need to be output. */
585 if (DECL_HARD_REGISTER (decl
))
588 gcc_checking_assert (!TREE_ASM_WRITTEN (decl
)
590 && !DECL_HAS_VALUE_EXPR_P (decl
));
592 if (!in_other_partition
593 && !DECL_EXTERNAL (decl
))
596 assemble_variable (decl
, 0, 1, 0);
597 gcc_assert (TREE_ASM_WRITTEN (decl
));
598 gcc_assert (definition
);
600 /* After the parser has generated debugging information, augment
601 this information with any new location/etc information that may
602 have become available after the compilation proper. */
603 debug_hooks
->late_global_decl (decl
);
610 /* Add NODE to queue starting at FIRST.
611 The queue is linked via AUX pointers and terminated by pointer to 1. */
614 enqueue_node (varpool_node
*node
, varpool_node
**first
)
618 gcc_checking_assert (*first
);
623 /* Optimization of function bodies might've rendered some variables as
624 unnecessary so we want to avoid these from being compiled. Re-do
625 reachability starting from variables that are either externally visible
626 or was referred from the asm output routines. */
629 symbol_table::remove_unreferenced_decls (void)
631 varpool_node
*next
, *node
;
632 varpool_node
*first
= (varpool_node
*)(void *)1;
635 hash_set
<varpool_node
*> referenced
;
641 fprintf (dump_file
, "Trivially needed variables:");
642 FOR_EACH_DEFINED_VARIABLE (node
)
645 && (!node
->can_remove_if_no_refs_p ()
646 /* We just expanded all function bodies. See if any of
647 them needed the variable. */
648 || DECL_RTL_SET_P (node
->decl
)))
650 enqueue_node (node
, &first
);
652 fprintf (dump_file
, " %s", node
->dump_asm_name ());
655 while (first
!= (varpool_node
*)(void *)1)
658 first
= (varpool_node
*)first
->aux
;
660 if (node
->same_comdat_group
)
663 for (next
= node
->same_comdat_group
;
665 next
= next
->same_comdat_group
)
667 varpool_node
*vnext
= dyn_cast
<varpool_node
*> (next
);
668 if (vnext
&& vnext
->analyzed
&& !next
->comdat_local_p ())
669 enqueue_node (vnext
, &first
);
672 for (i
= 0; node
->iterate_reference (i
, ref
); i
++)
674 varpool_node
*vnode
= dyn_cast
<varpool_node
*> (ref
->referred
);
676 && !vnode
->in_other_partition
677 && (!DECL_EXTERNAL (ref
->referred
->decl
)
680 enqueue_node (vnode
, &first
);
684 referenced
.add (vnode
);
685 while (vnode
&& vnode
->alias
&& vnode
->definition
)
687 vnode
= vnode
->get_alias_target ();
688 gcc_checking_assert (vnode
);
689 referenced
.add (vnode
);
695 fprintf (dump_file
, "\nRemoving variables:");
696 for (node
= first_defined_variable (); node
; node
= next
)
698 next
= next_defined_variable (node
);
699 if (!node
->aux
&& !node
->no_reorder
)
702 fprintf (dump_file
, " %s", node
->dump_asm_name ());
703 if (referenced
.contains(node
))
704 node
->remove_initializer ();
711 fprintf (dump_file
, "\n");
714 /* For variables in named sections make sure get_variable_section
715 is called before we switch to those sections. Then section
716 conflicts between read-only and read-only requiring relocations
717 sections can be resolved. */
719 varpool_node::finalize_named_section_flags (void)
721 if (!TREE_ASM_WRITTEN (decl
)
723 && !in_other_partition
724 && !DECL_EXTERNAL (decl
)
726 && !DECL_HAS_VALUE_EXPR_P (decl
)
728 get_variable_section (decl
, false);
731 /* Output all variables enqueued to be assembled. */
733 symbol_table::output_variables (void)
735 bool changed
= false;
741 remove_unreferenced_decls ();
743 timevar_push (TV_VAROUT
);
745 FOR_EACH_DEFINED_VARIABLE (node
)
747 /* Handled in output_in_order. */
748 if (node
->no_reorder
)
751 node
->finalize_named_section_flags ();
754 /* There is a similar loop in output_in_order. Please keep them in sync. */
755 FOR_EACH_VARIABLE (node
)
757 /* Handled in output_in_order. */
758 if (node
->no_reorder
)
760 if (DECL_HARD_REGISTER (node
->decl
)
761 || DECL_HAS_VALUE_EXPR_P (node
->decl
))
763 if (node
->definition
)
764 changed
|= node
->assemble_decl ();
766 assemble_undefined_decl (node
->decl
);
768 timevar_pop (TV_VAROUT
);
772 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
773 Extra name aliases are output whenever DECL is output. */
776 varpool_node::create_alias (tree alias
, tree decl
)
778 varpool_node
*alias_node
;
780 gcc_assert (VAR_P (decl
));
781 gcc_assert (VAR_P (alias
));
782 alias_node
= varpool_node::get_create (alias
);
783 alias_node
->alias
= true;
784 alias_node
->definition
= true;
785 alias_node
->semantic_interposition
= flag_semantic_interposition
;
786 alias_node
->alias_target
= decl
;
787 if (lookup_attribute ("weakref", DECL_ATTRIBUTES (alias
)) != NULL
)
788 alias_node
->weakref
= alias_node
->transparent_alias
= true;
792 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
793 Extra name aliases are output whenever DECL is output. */
796 varpool_node::create_extra_name_alias (tree alias
, tree decl
)
798 varpool_node
*alias_node
;
800 /* If aliases aren't supported by the assembler, fail. */
801 if (!TARGET_SUPPORTS_ALIASES
)
804 alias_node
= varpool_node::create_alias (alias
, decl
);
805 alias_node
->cpp_implicit_alias
= true;
807 /* Extra name alias mechanism creates aliases really late
808 via DECL_ASSEMBLER_NAME mechanism.
809 This is unfortunate because they are not going through the
810 standard channels. Ensure they get output. */
811 if (symtab
->cpp_implicit_aliases_done
)
812 alias_node
->resolve_alias (varpool_node::get_create (decl
));
816 /* Worker for call_for_symbol_and_aliases. */
819 varpool_node::call_for_symbol_and_aliases_1 (bool (*callback
) (varpool_node
*,
822 bool include_overwritable
)
826 FOR_EACH_ALIAS (this, ref
)
828 varpool_node
*alias
= dyn_cast
<varpool_node
*> (ref
->referring
);
829 if (include_overwritable
830 || alias
->get_availability () > AVAIL_INTERPOSABLE
)
831 if (alias
->call_for_symbol_and_aliases (callback
, data
,
832 include_overwritable
))