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 "basic-block.h"
31 #include "plugin-api.h"
36 #include "hard-reg-set.h"
41 #include "langhooks.h"
42 #include "diagnostic-core.h"
47 #include "gimple-expr.h"
49 #include "tree-ssa-alias.h"
51 #include "lto-streamer.h"
54 const char * const tls_model_names
[]={"none", "tls-emulated", "tls-real",
55 "tls-global-dynamic", "tls-local-dynamic",
56 "tls-initial-exec", "tls-local-exec"};
58 /* List of hooks triggered on varpool_node events. */
59 struct varpool_node_hook_list
{
60 varpool_node_hook hook
;
62 struct varpool_node_hook_list
*next
;
65 /* Register HOOK to be called with DATA on each removed node. */
66 varpool_node_hook_list
*
67 symbol_table::add_varpool_removal_hook (varpool_node_hook hook
, void *data
)
69 varpool_node_hook_list
*entry
;
70 varpool_node_hook_list
**ptr
= &m_first_varpool_removal_hook
;
72 entry
= (varpool_node_hook_list
*) xmalloc (sizeof (*entry
));
82 /* Remove ENTRY from the list of hooks called on removing nodes. */
84 symbol_table::remove_varpool_removal_hook (varpool_node_hook_list
*entry
)
86 varpool_node_hook_list
**ptr
= &m_first_varpool_removal_hook
;
94 /* Call all node removal hooks. */
96 symbol_table::call_varpool_removal_hooks (varpool_node
*node
)
98 varpool_node_hook_list
*entry
= m_first_varpool_removal_hook
;
101 entry
->hook (node
, entry
->data
);
106 /* Register HOOK to be called with DATA on each inserted node. */
107 varpool_node_hook_list
*
108 symbol_table::add_varpool_insertion_hook (varpool_node_hook hook
, void *data
)
110 varpool_node_hook_list
*entry
;
111 varpool_node_hook_list
**ptr
= &m_first_varpool_insertion_hook
;
113 entry
= (varpool_node_hook_list
*) xmalloc (sizeof (*entry
));
123 /* Remove ENTRY from the list of hooks called on inserted nodes. */
125 symbol_table::remove_varpool_insertion_hook (varpool_node_hook_list
*entry
)
127 varpool_node_hook_list
**ptr
= &m_first_varpool_insertion_hook
;
129 while (*ptr
!= entry
)
135 /* Call all node insertion hooks. */
137 symbol_table::call_varpool_insertion_hooks (varpool_node
*node
)
139 varpool_node_hook_list
*entry
= m_first_varpool_insertion_hook
;
142 entry
->hook (node
, entry
->data
);
147 /* Allocate new callgraph node and insert it into basic data structures. */
150 varpool_node::create_empty (void)
152 varpool_node
*node
= ggc_cleared_alloc
<varpool_node
> ();
153 node
->type
= SYMTAB_VARIABLE
;
157 /* Return varpool node assigned to DECL. Create new one when needed. */
159 varpool_node::get_create (tree decl
)
161 varpool_node
*node
= varpool_node::get (decl
);
162 gcc_checking_assert (TREE_CODE (decl
) == VAR_DECL
);
166 node
= varpool_node::create_empty ();
170 && lookup_attribute ("omp declare target", DECL_ATTRIBUTES (decl
)))
172 node
->offloadable
= 1;
173 g
->have_offload
= true;
176 node
->register_symbol ();
180 /* Remove variable from symbol table. */
183 varpool_node::remove (void)
185 symtab
->call_varpool_removal_hooks (this);
188 /* When streaming we can have multiple nodes associated with decl. */
189 if (symtab
->state
== LTO_STREAMING
)
191 /* Keep constructor when it may be used for folding. We remove
192 references to external variables before final compilation. */
193 else if (DECL_INITIAL (decl
) && DECL_INITIAL (decl
) != error_mark_node
194 && !ctor_useable_for_folding_p ())
195 remove_initializer ();
199 /* Remove node initializer when it is no longer needed. */
201 varpool_node::remove_initializer (void)
203 if (DECL_INITIAL (decl
)
204 && !DECL_IN_CONSTANT_POOL (decl
)
205 /* Keep vtables for BINFO folding. */
206 && !DECL_VIRTUAL_P (decl
)
207 /* FIXME: http://gcc.gnu.org/PR55395 */
208 && debug_info_level
== DINFO_LEVEL_NONE
209 /* When doing declaration merging we have duplicate
210 entries for given decl. Do not attempt to remove
211 the boides, or we will end up remiving
213 && symtab
->state
!= LTO_STREAMING
)
214 DECL_INITIAL (decl
) = error_mark_node
;
217 /* Dump given varpool node to F. */
219 varpool_node::dump (FILE *f
)
222 fprintf (f
, " Availability: %s\n",
223 symtab
->function_flags_ready
224 ? cgraph_availability_names
[get_availability ()]
226 fprintf (f
, " Varpool flags:");
227 if (DECL_INITIAL (decl
))
228 fprintf (f
, " initialized");
230 fprintf (f
, " output");
231 if (used_by_single_function
)
232 fprintf (f
, " used-by-single-function");
233 if (need_bounds_init
)
234 fprintf (f
, " need-bounds-init");
235 if (TREE_READONLY (decl
))
236 fprintf (f
, " read-only");
237 if (ctor_useable_for_folding_p ())
238 fprintf (f
, " const-value-known");
240 fprintf (f
, " write-only");
242 fprintf (f
, " %s", tls_model_names
[tls_model
]);
247 /* Dump given varpool node to stderr. */
248 void varpool_node::debug (void)
250 varpool_node::dump (stderr
);
253 /* Dump the variable pool to F. */
255 varpool_node::dump_varpool (FILE *f
)
259 fprintf (f
, "variable pool:\n\n");
260 FOR_EACH_VARIABLE (node
)
264 /* Dump the variable pool to stderr. */
267 varpool_node::debug_varpool (void)
269 dump_varpool (stderr
);
272 /* Given an assembler name, lookup node. */
274 varpool_node::get_for_asmname (tree asmname
)
276 if (symtab_node
*node
= symtab_node::get_for_asmname (asmname
))
277 return dyn_cast
<varpool_node
*> (node
);
282 /* When doing LTO, read variable's constructor from disk if
283 it is not already present. */
286 varpool_node::get_constructor (void)
288 lto_file_decl_data
*file_data
;
289 const char *data
, *name
;
292 if (DECL_INITIAL (decl
) != error_mark_node
294 return DECL_INITIAL (decl
);
296 timevar_push (TV_IPA_LTO_CTORS_IN
);
298 file_data
= lto_file_data
;
299 name
= IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (decl
));
301 /* We may have renamed the declaration, e.g., a static function. */
302 name
= lto_get_decl_name_mapping (file_data
, name
);
304 data
= lto_get_section_data (file_data
, LTO_section_function_body
,
307 fatal_error ("%s: section %s is missing",
308 file_data
->file_name
,
311 lto_input_variable_constructor (file_data
, this, data
);
312 lto_stats
.num_function_bodies
++;
313 lto_free_section_data (file_data
, LTO_section_function_body
, name
,
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 /* If we do not have a constructor, we can't use it. */
337 if (DECL_INITIAL (real_node
->decl
) == error_mark_node
338 && !real_node
->lto_file_data
)
341 /* Avoid attempts to load constructors that was not streamed. */
342 if (flag_ltrans
&& DECL_INITIAL (real_node
->decl
) == error_mark_node
343 && real_node
->body_removed
)
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 /* Alias of readonly variable is also readonly, since the variable is stored
357 in readonly memory. We also accept readonly aliases of non-readonly
358 locations assuming that user knows what he is asking for. */
359 if (!TREE_READONLY (decl
) && !TREE_READONLY (real_node
->decl
))
362 /* Variables declared 'const' without an initializer
363 have zero as the initializer if they may not be
364 overridden at link or run time.
366 It is actually requirement for C++ compiler to optimize const variables
367 consistently. As a GNU extension, do not enfore this rule for user defined
368 weak variables, so we support interposition on:
369 static const int dummy = 0;
370 extern const int foo __attribute__((__weak__, __alias__("dummy")));
372 if ((!DECL_INITIAL (real_node
->decl
)
373 || (DECL_WEAK (decl
) && !DECL_COMDAT (decl
)))
374 && (DECL_EXTERNAL (decl
) || decl_replaceable_p (decl
)))
377 /* Variables declared `const' with an initializer are considered
378 to not be overwritable with different initializer by default.
380 ??? Previously we behaved so for scalar variables but not for array
385 /* If DECLARATION is constant variable and its initial value is known
386 (so we can do constant folding), return its constructor (DECL_INITIAL).
387 This may be an expression or NULL when DECL is initialized to 0.
388 Return ERROR_MARK_NODE otherwise.
390 In LTO this may actually trigger reading the constructor from disk.
391 For this reason varpool_ctor_useable_for_folding_p should be used when
392 the actual constructor value is not needed. */
395 ctor_for_folding (tree decl
)
397 varpool_node
*node
, *real_node
;
400 if (TREE_CODE (decl
) != VAR_DECL
401 && TREE_CODE (decl
) != CONST_DECL
)
402 return error_mark_node
;
404 /* Static constant bounds are created to be
405 used instead of constants and therefore
406 do not let folding it. */
407 if (POINTER_BOUNDS_P (decl
))
408 return error_mark_node
;
410 if (TREE_CODE (decl
) == CONST_DECL
411 || DECL_IN_CONSTANT_POOL (decl
))
412 return DECL_INITIAL (decl
);
414 if (TREE_THIS_VOLATILE (decl
))
415 return error_mark_node
;
417 /* Do not care about automatic variables. Those are never initialized
418 anyway, because gimplifier exapnds the code. */
419 if (!TREE_STATIC (decl
) && !DECL_EXTERNAL (decl
))
421 gcc_assert (!TREE_PUBLIC (decl
));
422 return error_mark_node
;
425 gcc_assert (TREE_CODE (decl
) == VAR_DECL
);
427 real_node
= node
= varpool_node::get (decl
);
430 real_node
= node
->ultimate_alias_target ();
431 real_decl
= real_node
->decl
;
436 /* See if we are dealing with alias.
437 In most cases alias is just alternative symbol pointing to a given
438 constructor. This allows us to use interposition rules of DECL
439 constructor of REAL_NODE. However weakrefs are special by being just
440 alternative name of their target (if defined). */
441 if (decl
!= real_decl
)
443 gcc_assert (!DECL_INITIAL (decl
)
444 || (node
->alias
&& node
->get_alias_target () == real_node
)
445 || DECL_INITIAL (decl
) == error_mark_node
);
448 node
= node
->get_alias_target ();
453 if ((!DECL_VIRTUAL_P (real_decl
)
454 || DECL_INITIAL (real_decl
) == error_mark_node
455 || !DECL_INITIAL (real_decl
))
456 && (!node
|| !node
->ctor_useable_for_folding_p ()))
457 return error_mark_node
;
459 /* OK, we can return constructor. See if we need to fetch it from disk
461 if (DECL_INITIAL (real_decl
) != error_mark_node
463 return DECL_INITIAL (real_decl
);
464 return real_node
->get_constructor ();
467 /* Add the variable DECL to the varpool.
468 Unlike finalize_decl function is intended to be used
469 by middle end and allows insertion of new variable at arbitrary point
472 varpool_node::add (tree decl
)
475 varpool_node::finalize_decl (decl
);
476 node
= varpool_node::get_create (decl
);
477 symtab
->call_varpool_insertion_hooks (node
);
478 if (node
->externally_visible_p ())
479 node
->externally_visible
= true;
480 if (lookup_attribute ("no_reorder", DECL_ATTRIBUTES (decl
)))
481 node
->no_reorder
= 1;
484 /* Return variable availability. See cgraph.h for description of individual
487 varpool_node::get_availability (void)
490 return AVAIL_NOT_AVAILABLE
;
491 if (!TREE_PUBLIC (decl
))
492 return AVAIL_AVAILABLE
;
493 if (DECL_IN_CONSTANT_POOL (decl
)
494 || DECL_VIRTUAL_P (decl
))
495 return AVAIL_AVAILABLE
;
496 if (alias
&& weakref
)
498 enum availability avail
;
500 ultimate_alias_target (&avail
)->get_availability ();
503 /* If the variable can be overwritten, return OVERWRITABLE. Takes
504 care of at least one notable extension - the COMDAT variables
505 used to share template instantiations in C++. */
506 if (decl_replaceable_p (decl
)
507 || DECL_EXTERNAL (decl
))
508 return AVAIL_INTERPOSABLE
;
509 return AVAIL_AVAILABLE
;
513 varpool_node::analyze (void)
515 /* When reading back varpool at LTO time, we re-construct the queue in order
516 to have "needed" list right by inserting all needed nodes into varpool.
517 We however don't want to re-analyze already analyzed nodes. */
520 gcc_assert (!in_lto_p
|| symtab
->function_flags_ready
);
521 /* Compute the alignment early so function body expanders are
522 already informed about increased alignment. */
523 align_variable (decl
, 0);
526 resolve_alias (varpool_node::get (alias_target
));
527 else if (DECL_INITIAL (decl
))
528 record_references_in_initializer (decl
, analyzed
);
532 /* Assemble thunks and aliases associated to varpool node. */
535 varpool_node::assemble_aliases (void)
539 FOR_EACH_ALIAS (this, ref
)
541 varpool_node
*alias
= dyn_cast
<varpool_node
*> (ref
->referring
);
542 do_assemble_alias (alias
->decl
,
543 DECL_ASSEMBLER_NAME (decl
));
544 alias
->assemble_aliases ();
548 /* Output one variable, if necessary. Return whether we output it. */
551 varpool_node::assemble_decl (void)
553 /* Aliases are outout when their target is produced or by
558 /* Constant pool is output from RTL land when the reference
559 survive till this level. */
560 if (DECL_IN_CONSTANT_POOL (decl
) && TREE_ASM_WRITTEN (decl
))
563 /* Decls with VALUE_EXPR should not be in the varpool at all. They
564 are not real variables, but just info for debugging and codegen.
565 Unfortunately at the moment emutls is not updating varpool correctly
566 after turning real vars into value_expr vars. */
567 if (DECL_HAS_VALUE_EXPR_P (decl
)
568 && !targetm
.have_tls
)
571 /* Hard register vars do not need to be output. */
572 if (DECL_HARD_REGISTER (decl
))
575 gcc_checking_assert (!TREE_ASM_WRITTEN (decl
)
576 && TREE_CODE (decl
) == VAR_DECL
577 && !DECL_HAS_VALUE_EXPR_P (decl
));
579 if (!in_other_partition
580 && !DECL_EXTERNAL (decl
))
583 assemble_variable (decl
, 0, 1, 0);
584 gcc_assert (TREE_ASM_WRITTEN (decl
));
585 gcc_assert (definition
);
593 /* Add NODE to queue starting at FIRST.
594 The queue is linked via AUX pointers and terminated by pointer to 1. */
597 enqueue_node (varpool_node
*node
, varpool_node
**first
)
601 gcc_checking_assert (*first
);
606 /* Optimization of function bodies might've rendered some variables as
607 unnecessary so we want to avoid these from being compiled. Re-do
608 reachability starting from variables that are either externally visible
609 or was referred from the asm output routines. */
612 symbol_table::remove_unreferenced_decls (void)
614 varpool_node
*next
, *node
;
615 varpool_node
*first
= (varpool_node
*)(void *)1;
618 hash_set
<varpool_node
*> referenced
;
624 fprintf (dump_file
, "Trivially needed variables:");
625 FOR_EACH_DEFINED_VARIABLE (node
)
628 && (!node
->can_remove_if_no_refs_p ()
629 /* We just expanded all function bodies. See if any of
630 them needed the variable. */
631 || DECL_RTL_SET_P (node
->decl
)))
633 enqueue_node (node
, &first
);
635 fprintf (dump_file
, " %s", node
->asm_name ());
638 while (first
!= (varpool_node
*)(void *)1)
641 first
= (varpool_node
*)first
->aux
;
643 if (node
->same_comdat_group
)
646 for (next
= node
->same_comdat_group
;
648 next
= next
->same_comdat_group
)
650 varpool_node
*vnext
= dyn_cast
<varpool_node
*> (next
);
651 if (vnext
&& vnext
->analyzed
&& !next
->comdat_local_p ())
652 enqueue_node (vnext
, &first
);
655 for (i
= 0; node
->iterate_reference (i
, ref
); i
++)
657 varpool_node
*vnode
= dyn_cast
<varpool_node
*> (ref
->referred
);
659 && !vnode
->in_other_partition
660 && (!DECL_EXTERNAL (ref
->referred
->decl
)
663 enqueue_node (vnode
, &first
);
665 referenced
.add (node
);
669 fprintf (dump_file
, "\nRemoving variables:");
670 for (node
= first_defined_variable (); node
; node
= next
)
672 next
= next_defined_variable (node
);
673 if (!node
->aux
&& !node
->no_reorder
)
676 fprintf (dump_file
, " %s", node
->asm_name ());
677 if (referenced
.contains(node
))
678 node
->remove_initializer ();
685 fprintf (dump_file
, "\n");
688 /* For variables in named sections make sure get_variable_section
689 is called before we switch to those sections. Then section
690 conflicts between read-only and read-only requiring relocations
691 sections can be resolved. */
693 varpool_node::finalize_named_section_flags (void)
695 if (!TREE_ASM_WRITTEN (decl
)
697 && !in_other_partition
698 && !DECL_EXTERNAL (decl
)
699 && TREE_CODE (decl
) == VAR_DECL
700 && !DECL_HAS_VALUE_EXPR_P (decl
)
702 get_variable_section (decl
, false);
705 /* Output all variables enqueued to be assembled. */
707 symbol_table::output_variables (void)
709 bool changed
= false;
715 remove_unreferenced_decls ();
717 timevar_push (TV_VAROUT
);
719 FOR_EACH_VARIABLE (node
)
720 if (!node
->definition
)
721 assemble_undefined_decl (node
->decl
);
722 FOR_EACH_DEFINED_VARIABLE (node
)
724 /* Handled in output_in_order. */
725 if (node
->no_reorder
)
728 node
->finalize_named_section_flags ();
731 FOR_EACH_DEFINED_VARIABLE (node
)
733 /* Handled in output_in_order. */
734 if (node
->no_reorder
)
736 if (node
->assemble_decl ())
739 timevar_pop (TV_VAROUT
);
743 /* Create a new global variable of type TYPE. */
745 add_new_static_var (tree type
)
748 varpool_node
*new_node
;
750 new_decl
= create_tmp_var_raw (type
, NULL
);
751 DECL_NAME (new_decl
) = create_tmp_var_name (NULL
);
752 TREE_READONLY (new_decl
) = 0;
753 TREE_STATIC (new_decl
) = 1;
754 TREE_USED (new_decl
) = 1;
755 DECL_CONTEXT (new_decl
) = NULL_TREE
;
756 DECL_ABSTRACT_P (new_decl
) = false;
757 lang_hooks
.dup_lang_specific_decl (new_decl
);
758 new_node
= varpool_node::get_create (new_decl
);
759 varpool_node::finalize_decl (new_decl
);
761 return new_node
->decl
;
764 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
765 Extra name aliases are output whenever DECL is output. */
768 varpool_node::create_alias (tree alias
, tree decl
)
770 varpool_node
*alias_node
;
772 gcc_assert (TREE_CODE (decl
) == VAR_DECL
);
773 gcc_assert (TREE_CODE (alias
) == VAR_DECL
);
774 alias_node
= varpool_node::get_create (alias
);
775 alias_node
->alias
= true;
776 alias_node
->definition
= true;
777 alias_node
->alias_target
= decl
;
778 if (lookup_attribute ("weakref", DECL_ATTRIBUTES (alias
)) != NULL
)
779 alias_node
->weakref
= true;
783 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
784 Extra name aliases are output whenever DECL is output. */
787 varpool_node::create_extra_name_alias (tree alias
, tree decl
)
789 varpool_node
*alias_node
;
791 #ifndef ASM_OUTPUT_DEF
792 /* If aliases aren't supported by the assembler, fail. */
795 alias_node
= varpool_node::create_alias (alias
, decl
);
796 alias_node
->cpp_implicit_alias
= true;
798 /* Extra name alias mechanizm creates aliases really late
799 via DECL_ASSEMBLER_NAME mechanizm.
800 This is unfortunate because they are not going through the
801 standard channels. Ensure they get output. */
802 if (symtab
->cpp_implicit_aliases_done
)
803 alias_node
->resolve_alias (varpool_node::get_create (decl
));
807 /* Call calback on varpool symbol and aliases associated to varpool symbol.
808 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
812 varpool_node::call_for_node_and_aliases (bool (*callback
) (varpool_node
*,
815 bool include_overwritable
)
819 if (callback (this, data
))
822 FOR_EACH_ALIAS (this, ref
)
824 varpool_node
*alias
= dyn_cast
<varpool_node
*> (ref
->referring
);
825 if (include_overwritable
826 || alias
->get_availability () > AVAIL_INTERPOSABLE
)
827 if (alias
->call_for_node_and_aliases (callback
, data
,
828 include_overwritable
))