PR rtl-optimization/88470
[official-gcc.git] / gcc / ipa.c
blob89fb1da50fd42fd0e3e926c530ec699822efbaa1
1 /* Basic IPA optimizations and utilities.
2 Copyright (C) 2003-2018 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
9 version.
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 for more details.
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
20 #include "config.h"
21 #include "system.h"
22 #include "coretypes.h"
23 #include "backend.h"
24 #include "target.h"
25 #include "tree.h"
26 #include "gimple.h"
27 #include "alloc-pool.h"
28 #include "tree-pass.h"
29 #include "stringpool.h"
30 #include "cgraph.h"
31 #include "gimplify.h"
32 #include "tree-iterator.h"
33 #include "ipa-utils.h"
34 #include "symbol-summary.h"
35 #include "tree-vrp.h"
36 #include "ipa-prop.h"
37 #include "ipa-fnsummary.h"
38 #include "dbgcnt.h"
39 #include "debug.h"
40 #include "stringpool.h"
41 #include "attribs.h"
43 /* Return true when NODE has ADDR reference. */
45 static bool
46 has_addr_references_p (struct cgraph_node *node,
47 void *)
49 int i;
50 struct ipa_ref *ref = NULL;
52 for (i = 0; node->iterate_referring (i, ref); i++)
53 if (ref->use == IPA_REF_ADDR)
54 return true;
55 return false;
58 /* Return true when NODE can be target of an indirect call. */
60 static bool
61 is_indirect_call_target_p (struct cgraph_node *node, void *)
63 return node->indirect_call_target;
66 /* Look for all functions inlined to NODE and update their inlined_to pointers
67 to INLINED_TO. */
69 static void
70 update_inlined_to_pointer (struct cgraph_node *node, struct cgraph_node *inlined_to)
72 struct cgraph_edge *e;
73 for (e = node->callees; e; e = e->next_callee)
74 if (e->callee->global.inlined_to)
76 e->callee->global.inlined_to = inlined_to;
77 update_inlined_to_pointer (e->callee, inlined_to);
81 /* Add symtab NODE to queue starting at FIRST.
83 The queue is linked via AUX pointers and terminated by pointer to 1.
84 We enqueue nodes at two occasions: when we find them reachable or when we find
85 their bodies needed for further clonning. In the second case we mark them
86 by pointer to 2 after processing so they are re-queue when they become
87 reachable. */
89 static void
90 enqueue_node (symtab_node *node, symtab_node **first,
91 hash_set<symtab_node *> *reachable)
93 /* Node is still in queue; do nothing. */
94 if (node->aux && node->aux != (void *) 2)
95 return;
96 /* Node was already processed as unreachable, re-enqueue
97 only if it became reachable now. */
98 if (node->aux == (void *)2 && !reachable->contains (node))
99 return;
100 node->aux = *first;
101 *first = node;
104 /* Return true if NODE may get inlined later.
105 This is used to keep DECL_EXTERNAL function bodies around long enough
106 so inliner can proces them. */
108 static bool
109 possible_inline_candidate_p (symtab_node *node)
111 if (symtab->state >= IPA_SSA_AFTER_INLINING)
112 return false;
113 cgraph_node *cnode = dyn_cast <cgraph_node *> (node);
114 if (!cnode)
115 return false;
116 if (DECL_UNINLINABLE (cnode->decl))
117 return false;
118 if (opt_for_fn (cnode->decl, optimize))
119 return true;
120 if (symtab->state >= IPA_SSA)
121 return false;
122 return lookup_attribute ("always_inline", DECL_ATTRIBUTES (node->decl));
125 /* Process references. */
127 static void
128 process_references (symtab_node *snode,
129 symtab_node **first,
130 hash_set<symtab_node *> *reachable)
132 int i;
133 struct ipa_ref *ref = NULL;
134 for (i = 0; snode->iterate_reference (i, ref); i++)
136 symtab_node *node = ref->referred;
137 symtab_node *body = node->ultimate_alias_target ();
139 if (node->definition && !node->in_other_partition
140 && ((!DECL_EXTERNAL (node->decl) || node->alias)
141 || (possible_inline_candidate_p (node)
142 /* We use variable constructors during late compilation for
143 constant folding. Keep references alive so partitioning
144 knows about potential references. */
145 || (VAR_P (node->decl)
146 && (flag_wpa
147 || flag_incremental_link
148 == INCREMENTAL_LINK_LTO)
149 && dyn_cast <varpool_node *> (node)
150 ->ctor_useable_for_folding_p ()))))
152 /* Be sure that we will not optimize out alias target
153 body. */
154 if (DECL_EXTERNAL (node->decl)
155 && node->alias
156 && symtab->state < IPA_SSA_AFTER_INLINING)
157 reachable->add (body);
158 reachable->add (node);
160 enqueue_node (node, first, reachable);
164 /* EDGE is an polymorphic call. If BEFORE_INLINING_P is set, mark
165 all its potential targets as reachable to permit later inlining if
166 devirtualization happens. After inlining still keep their declarations
167 around, so we can devirtualize to a direct call.
169 Also try to make trivial devirutalization when no or only one target is
170 possible. */
172 static void
173 walk_polymorphic_call_targets (hash_set<void *> *reachable_call_targets,
174 struct cgraph_edge *edge,
175 symtab_node **first,
176 hash_set<symtab_node *> *reachable)
178 unsigned int i;
179 void *cache_token;
180 bool final;
181 vec <cgraph_node *>targets
182 = possible_polymorphic_call_targets
183 (edge, &final, &cache_token);
185 if (!reachable_call_targets->add (cache_token))
187 for (i = 0; i < targets.length (); i++)
189 struct cgraph_node *n = targets[i];
191 /* Do not bother to mark virtual methods in anonymous namespace;
192 either we will find use of virtual table defining it, or it is
193 unused. */
194 if (TREE_CODE (TREE_TYPE (n->decl)) == METHOD_TYPE
195 && type_in_anonymous_namespace_p
196 (TYPE_METHOD_BASETYPE (TREE_TYPE (n->decl))))
197 continue;
199 n->indirect_call_target = true;
200 symtab_node *body = n->function_symbol ();
202 /* Prior inlining, keep alive bodies of possible targets for
203 devirtualization. */
204 if (n->definition
205 && (possible_inline_candidate_p (body)
206 && opt_for_fn (body->decl, flag_devirtualize)))
208 /* Be sure that we will not optimize out alias target
209 body. */
210 if (DECL_EXTERNAL (n->decl)
211 && n->alias
212 && symtab->state < IPA_SSA_AFTER_INLINING)
213 reachable->add (body);
214 reachable->add (n);
216 /* Even after inlining we want to keep the possible targets in the
217 boundary, so late passes can still produce direct call even if
218 the chance for inlining is lost. */
219 enqueue_node (n, first, reachable);
223 /* Very trivial devirtualization; when the type is
224 final or anonymous (so we know all its derivation)
225 and there is only one possible virtual call target,
226 make the edge direct. */
227 if (final)
229 if (targets.length () <= 1 && dbg_cnt (devirt))
231 cgraph_node *target, *node = edge->caller;
232 if (targets.length () == 1)
233 target = targets[0];
234 else
235 target = cgraph_node::get_create
236 (builtin_decl_implicit (BUILT_IN_UNREACHABLE));
238 if (dump_enabled_p ())
240 dump_printf_loc (MSG_OPTIMIZED_LOCATIONS, edge->call_stmt,
241 "devirtualizing call in %s to %s\n",
242 edge->caller->dump_name (),
243 target->dump_name ());
245 edge = edge->make_direct (target);
246 if (ipa_fn_summaries)
247 ipa_update_overall_fn_summary (node);
248 else if (edge->call_stmt)
249 edge->redirect_call_stmt_to_callee ();
254 /* Perform reachability analysis and reclaim all unreachable nodes.
256 The algorithm is basically mark&sweep but with some extra refinements:
258 - reachable extern inline functions needs special handling; the bodies needs
259 to stay in memory until inlining in hope that they will be inlined.
260 After inlining we release their bodies and turn them into unanalyzed
261 nodes even when they are reachable.
263 - virtual functions are kept in callgraph even if they seem unreachable in
264 hope calls to them will be devirtualized.
266 Again we remove them after inlining. In late optimization some
267 devirtualization may happen, but it is not important since we won't inline
268 the call. In theory early opts and IPA should work out all important cases.
270 - virtual clones needs bodies of their origins for later materialization;
271 this means that we want to keep the body even if the origin is unreachable
272 otherwise. To avoid origin from sitting in the callgraph and being
273 walked by IPA passes, we turn them into unanalyzed nodes with body
274 defined.
276 We maintain set of function declaration where body needs to stay in
277 body_needed_for_clonning
279 Inline clones represent special case: their declaration match the
280 declaration of origin and cgraph_remove_node already knows how to
281 reshape callgraph and preserve body when offline copy of function or
282 inline clone is being removed.
284 - C++ virtual tables keyed to other unit are represented as DECL_EXTERNAL
285 variables with DECL_INITIAL set. We finalize these and keep reachable
286 ones around for constant folding purposes. After inlining we however
287 stop walking their references to let everything static referneced by them
288 to be removed when it is otherwise unreachable.
290 We maintain queue of both reachable symbols (i.e. defined symbols that needs
291 to stay) and symbols that are in boundary (i.e. external symbols referenced
292 by reachable symbols or origins of clones). The queue is represented
293 as linked list by AUX pointer terminated by 1.
295 At the end we keep all reachable symbols. For symbols in boundary we always
296 turn definition into a declaration, but we may keep function body around
297 based on body_needed_for_clonning
299 All symbols that enter the queue have AUX pointer non-zero and are in the
300 boundary. Pointer set REACHABLE is used to track reachable symbols.
302 Every symbol can be visited twice - once as part of boundary and once
303 as real reachable symbol. enqueue_node needs to decide whether the
304 node needs to be re-queued for second processing. For this purpose
305 we set AUX pointer of processed symbols in the boundary to constant 2. */
307 bool
308 symbol_table::remove_unreachable_nodes (FILE *file)
310 symtab_node *first = (symtab_node *) (void *) 1;
311 struct cgraph_node *node, *next;
312 varpool_node *vnode, *vnext;
313 bool changed = false;
314 hash_set<symtab_node *> reachable;
315 hash_set<tree> body_needed_for_clonning;
316 hash_set<void *> reachable_call_targets;
318 timevar_push (TV_IPA_UNREACHABLE);
319 build_type_inheritance_graph ();
320 if (file)
321 fprintf (file, "\nReclaiming functions:");
322 if (flag_checking)
324 FOR_EACH_FUNCTION (node)
325 gcc_assert (!node->aux);
326 FOR_EACH_VARIABLE (vnode)
327 gcc_assert (!vnode->aux);
329 /* Mark functions whose bodies are obviously needed.
330 This is mostly when they can be referenced externally. Inline clones
331 are special since their declarations are shared with master clone and thus
332 cgraph_can_remove_if_no_direct_calls_and_refs_p should not be called on them. */
333 FOR_EACH_FUNCTION (node)
335 node->used_as_abstract_origin = false;
336 node->indirect_call_target = false;
337 if (node->definition
338 && !node->global.inlined_to
339 && !node->in_other_partition
340 && !node->can_remove_if_no_direct_calls_and_refs_p ())
342 gcc_assert (!node->global.inlined_to);
343 reachable.add (node);
344 enqueue_node (node, &first, &reachable);
346 else
347 gcc_assert (!node->aux);
350 /* Mark variables that are obviously needed. */
351 FOR_EACH_DEFINED_VARIABLE (vnode)
352 if (!vnode->can_remove_if_no_refs_p()
353 && !vnode->in_other_partition)
355 reachable.add (vnode);
356 enqueue_node (vnode, &first, &reachable);
359 /* Perform reachability analysis. */
360 while (first != (symtab_node *) (void *) 1)
362 bool in_boundary_p = !reachable.contains (first);
363 symtab_node *node = first;
365 first = (symtab_node *)first->aux;
367 /* If we are processing symbol in boundary, mark its AUX pointer for
368 possible later re-processing in enqueue_node. */
369 if (in_boundary_p)
371 node->aux = (void *)2;
372 if (node->alias && node->analyzed)
373 enqueue_node (node->get_alias_target (), &first, &reachable);
375 else
377 if (TREE_CODE (node->decl) == FUNCTION_DECL
378 && DECL_ABSTRACT_ORIGIN (node->decl))
380 struct cgraph_node *origin_node
381 = cgraph_node::get (DECL_ABSTRACT_ORIGIN (node->decl));
382 if (origin_node && !origin_node->used_as_abstract_origin)
384 origin_node->used_as_abstract_origin = true;
385 gcc_assert (!origin_node->prev_sibling_clone);
386 gcc_assert (!origin_node->next_sibling_clone);
387 for (cgraph_node *n = origin_node->clones; n;
388 n = n->next_sibling_clone)
389 if (n->decl == DECL_ABSTRACT_ORIGIN (node->decl))
390 n->used_as_abstract_origin = true;
393 /* If any symbol in a comdat group is reachable, force
394 all externally visible symbols in the same comdat
395 group to be reachable as well. Comdat-local symbols
396 can be discarded if all uses were inlined. */
397 if (node->same_comdat_group)
399 symtab_node *next;
400 for (next = node->same_comdat_group;
401 next != node;
402 next = next->same_comdat_group)
403 if (!next->comdat_local_p ()
404 && !reachable.add (next))
405 enqueue_node (next, &first, &reachable);
407 /* Mark references as reachable. */
408 process_references (node, &first, &reachable);
411 if (cgraph_node *cnode = dyn_cast <cgraph_node *> (node))
413 /* Mark the callees reachable unless they are direct calls to extern
414 inline functions we decided to not inline. */
415 if (!in_boundary_p)
417 struct cgraph_edge *e;
418 /* Keep alive possible targets for devirtualization. */
419 if (opt_for_fn (cnode->decl, optimize)
420 && opt_for_fn (cnode->decl, flag_devirtualize))
422 struct cgraph_edge *next;
423 for (e = cnode->indirect_calls; e; e = next)
425 next = e->next_callee;
426 if (e->indirect_info->polymorphic)
427 walk_polymorphic_call_targets (&reachable_call_targets,
428 e, &first, &reachable);
431 for (e = cnode->callees; e; e = e->next_callee)
433 symtab_node *body = e->callee->function_symbol ();
434 if (e->callee->definition
435 && !e->callee->in_other_partition
436 && (!e->inline_failed
437 || !DECL_EXTERNAL (e->callee->decl)
438 || e->callee->alias
439 || possible_inline_candidate_p (e->callee)))
441 /* Be sure that we will not optimize out alias target
442 body. */
443 if (DECL_EXTERNAL (e->callee->decl)
444 && e->callee->alias
445 && symtab->state < IPA_SSA_AFTER_INLINING)
446 reachable.add (body);
447 reachable.add (e->callee);
449 enqueue_node (e->callee, &first, &reachable);
452 /* When inline clone exists, mark body to be preserved so when removing
453 offline copy of the function we don't kill it. */
454 if (cnode->global.inlined_to)
455 body_needed_for_clonning.add (cnode->decl);
457 /* For non-inline clones, force their origins to the boundary and ensure
458 that body is not removed. */
459 while (cnode->clone_of)
461 bool noninline = cnode->clone_of->decl != cnode->decl;
462 cnode = cnode->clone_of;
463 if (noninline)
465 body_needed_for_clonning.add (cnode->decl);
466 enqueue_node (cnode, &first, &reachable);
471 else if (cnode->thunk.thunk_p)
472 enqueue_node (cnode->callees->callee, &first, &reachable);
474 /* If any reachable function has simd clones, mark them as
475 reachable as well. */
476 if (cnode->simd_clones)
478 cgraph_node *next;
479 for (next = cnode->simd_clones;
480 next;
481 next = next->simdclone->next_clone)
482 if (in_boundary_p
483 || !reachable.add (next))
484 enqueue_node (next, &first, &reachable);
487 /* When we see constructor of external variable, keep referred nodes in the
488 boundary. This will also hold initializers of the external vars NODE
489 refers to. */
490 varpool_node *vnode = dyn_cast <varpool_node *> (node);
491 if (vnode
492 && DECL_EXTERNAL (node->decl)
493 && !vnode->alias
494 && in_boundary_p)
496 struct ipa_ref *ref = NULL;
497 for (int i = 0; node->iterate_reference (i, ref); i++)
498 enqueue_node (ref->referred, &first, &reachable);
502 /* Remove unreachable functions. */
503 for (node = first_function (); node; node = next)
505 next = next_function (node);
507 /* If node is not needed at all, remove it. */
508 if (!node->aux)
510 if (file)
511 fprintf (file, " %s", node->dump_name ());
512 node->remove ();
513 changed = true;
515 /* If node is unreachable, remove its body. */
516 else if (!reachable.contains (node))
518 /* We keep definitions of thunks and aliases in the boundary so
519 we can walk to the ultimate alias targets and function symbols
520 reliably. */
521 if (node->alias || node->thunk.thunk_p)
523 else if (!body_needed_for_clonning.contains (node->decl)
524 && !node->alias && !node->thunk.thunk_p)
525 node->release_body ();
526 else if (!node->clone_of)
527 gcc_assert (in_lto_p || DECL_RESULT (node->decl));
528 if (node->definition && !node->alias && !node->thunk.thunk_p)
530 if (file)
531 fprintf (file, " %s", node->dump_name ());
532 node->body_removed = true;
533 node->analyzed = false;
534 node->definition = false;
535 node->cpp_implicit_alias = false;
536 node->alias = false;
537 node->transparent_alias = false;
538 node->thunk.thunk_p = false;
539 node->weakref = false;
540 /* After early inlining we drop always_inline attributes on
541 bodies of functions that are still referenced (have their
542 address taken). */
543 DECL_ATTRIBUTES (node->decl)
544 = remove_attribute ("always_inline",
545 DECL_ATTRIBUTES (node->decl));
546 if (!node->in_other_partition)
547 node->local.local = false;
548 node->remove_callees ();
549 node->remove_all_references ();
550 changed = true;
551 if (node->thunk.thunk_p
552 && node->thunk.add_pointer_bounds_args)
554 node->thunk.thunk_p = false;
555 node->thunk.add_pointer_bounds_args = false;
559 else
560 gcc_assert (node->clone_of || !node->has_gimple_body_p ()
561 || in_lto_p || DECL_RESULT (node->decl));
564 /* Inline clones might be kept around so their materializing allows further
565 cloning. If the function the clone is inlined into is removed, we need
566 to turn it into normal cone. */
567 FOR_EACH_FUNCTION (node)
569 if (node->global.inlined_to
570 && !node->callers)
572 gcc_assert (node->clones);
573 node->global.inlined_to = NULL;
574 update_inlined_to_pointer (node, node);
576 node->aux = NULL;
579 /* Remove unreachable variables. */
580 if (file)
581 fprintf (file, "\nReclaiming variables:");
582 for (vnode = first_variable (); vnode; vnode = vnext)
584 vnext = next_variable (vnode);
585 if (!vnode->aux
586 /* For can_refer_decl_in_current_unit_p we want to track for
587 all external variables if they are defined in other partition
588 or not. */
589 && (!flag_ltrans || !DECL_EXTERNAL (vnode->decl)))
591 struct ipa_ref *ref = NULL;
593 /* First remove the aliases, so varpool::remove can possibly lookup
594 the constructor and save it for future use. */
595 while (vnode->iterate_direct_aliases (0, ref))
597 if (file)
598 fprintf (file, " %s", ref->referred->dump_name ());
599 ref->referring->remove ();
601 if (file)
602 fprintf (file, " %s", vnode->dump_name ());
603 vnext = next_variable (vnode);
604 /* Signal removal to the debug machinery. */
605 if (! flag_wpa || flag_incremental_link == INCREMENTAL_LINK_LTO)
607 vnode->definition = false;
608 (*debug_hooks->late_global_decl) (vnode->decl);
610 vnode->remove ();
611 changed = true;
613 else if (!reachable.contains (vnode) && !vnode->alias)
615 tree init;
616 if (vnode->definition)
618 if (file)
619 fprintf (file, " %s", vnode->name ());
620 changed = true;
622 /* Keep body if it may be useful for constant folding. */
623 if ((flag_wpa || flag_incremental_link == INCREMENTAL_LINK_LTO)
624 || ((init = ctor_for_folding (vnode->decl)) == error_mark_node))
625 vnode->remove_initializer ();
626 else
627 DECL_INITIAL (vnode->decl) = init;
628 vnode->body_removed = true;
629 vnode->definition = false;
630 vnode->analyzed = false;
631 vnode->aux = NULL;
633 vnode->remove_from_same_comdat_group ();
635 vnode->remove_all_references ();
637 else
638 vnode->aux = NULL;
641 /* Now update address_taken flags and try to promote functions to be local. */
642 if (file)
643 fprintf (file, "\nClearing address taken flags:");
644 FOR_EACH_DEFINED_FUNCTION (node)
645 if (node->address_taken
646 && !node->used_from_other_partition)
648 if (!node->call_for_symbol_and_aliases
649 (has_addr_references_p, NULL, true))
651 if (file)
652 fprintf (file, " %s", node->name ());
653 node->address_taken = false;
654 changed = true;
655 if (node->local_p ()
656 /* Virtual functions may be kept in cgraph just because
657 of possible later devirtualization. Do not mark them as
658 local too early so we won't optimize them out before
659 we are done with polymorphic call analysis. */
660 && (symtab->state >= IPA_SSA_AFTER_INLINING
661 || !node->call_for_symbol_and_aliases
662 (is_indirect_call_target_p, NULL, true)))
664 node->local.local = true;
665 if (file)
666 fprintf (file, " (local)");
670 if (file)
671 fprintf (file, "\n");
673 symtab_node::checking_verify_symtab_nodes ();
675 /* If we removed something, perhaps profile could be improved. */
676 if (changed && (optimize || in_lto_p) && ipa_call_summaries)
677 FOR_EACH_DEFINED_FUNCTION (node)
678 ipa_propagate_frequency (node);
680 timevar_pop (TV_IPA_UNREACHABLE);
681 return changed;
684 /* Process references to VNODE and set flags WRITTEN, ADDRESS_TAKEN, READ
685 as needed, also clear EXPLICIT_REFS if the references to given variable
686 do not need to be explicit. */
688 void
689 process_references (varpool_node *vnode,
690 bool *written, bool *address_taken,
691 bool *read, bool *explicit_refs)
693 int i;
694 struct ipa_ref *ref;
696 if (!vnode->all_refs_explicit_p ()
697 || TREE_THIS_VOLATILE (vnode->decl))
698 *explicit_refs = false;
700 for (i = 0; vnode->iterate_referring (i, ref)
701 && *explicit_refs && (!*written || !*address_taken || !*read); i++)
702 switch (ref->use)
704 case IPA_REF_ADDR:
705 *address_taken = true;
706 break;
707 case IPA_REF_LOAD:
708 *read = true;
709 break;
710 case IPA_REF_STORE:
711 *written = true;
712 break;
713 case IPA_REF_ALIAS:
714 process_references (dyn_cast<varpool_node *> (ref->referring), written,
715 address_taken, read, explicit_refs);
716 break;
720 /* Set TREE_READONLY bit. */
722 bool
723 set_readonly_bit (varpool_node *vnode, void *data ATTRIBUTE_UNUSED)
725 TREE_READONLY (vnode->decl) = true;
726 return false;
729 /* Set writeonly bit and clear the initalizer, since it will not be needed. */
731 bool
732 set_writeonly_bit (varpool_node *vnode, void *data)
734 vnode->writeonly = true;
735 if (optimize || in_lto_p)
737 DECL_INITIAL (vnode->decl) = NULL;
738 if (!vnode->alias)
740 if (vnode->num_references ())
741 *(bool *)data = true;
742 vnode->remove_all_references ();
745 return false;
748 /* Clear addressale bit of VNODE. */
750 bool
751 clear_addressable_bit (varpool_node *vnode, void *data ATTRIBUTE_UNUSED)
753 vnode->address_taken = false;
754 TREE_ADDRESSABLE (vnode->decl) = 0;
755 return false;
758 /* Discover variables that have no longer address taken, are read-only or
759 write-only and update their flags.
761 Return true when unreachable symbol removal should be done.
763 FIXME: This can not be done in between gimplify and omp_expand since
764 readonly flag plays role on what is shared and what is not. Currently we do
765 this transformation as part of whole program visibility and re-do at
766 ipa-reference pass (to take into account clonning), but it would
767 make sense to do it before early optimizations. */
769 bool
770 ipa_discover_variable_flags (void)
772 if (!flag_ipa_reference_addressable)
773 return false;
775 bool remove_p = false;
776 varpool_node *vnode;
777 if (dump_file)
778 fprintf (dump_file, "Clearing variable flags:");
779 FOR_EACH_VARIABLE (vnode)
780 if (!vnode->alias
781 && (TREE_ADDRESSABLE (vnode->decl)
782 || !vnode->writeonly
783 || !TREE_READONLY (vnode->decl)))
785 bool written = false;
786 bool address_taken = false;
787 bool read = false;
788 bool explicit_refs = true;
790 process_references (vnode, &written, &address_taken, &read,
791 &explicit_refs);
792 if (!explicit_refs)
793 continue;
794 if (!address_taken)
796 if (TREE_ADDRESSABLE (vnode->decl) && dump_file)
797 fprintf (dump_file, " %s (non-addressable)", vnode->name ());
798 vnode->call_for_symbol_and_aliases (clear_addressable_bit, NULL,
799 true);
801 if (!address_taken && !written
802 /* Making variable in explicit section readonly can cause section
803 type conflict.
804 See e.g. gcc.c-torture/compile/pr23237.c */
805 && vnode->get_section () == NULL)
807 if (!TREE_READONLY (vnode->decl) && dump_file)
808 fprintf (dump_file, " %s (read-only)", vnode->name ());
809 vnode->call_for_symbol_and_aliases (set_readonly_bit, NULL, true);
811 if (!vnode->writeonly && !read && !address_taken && written)
813 if (dump_file)
814 fprintf (dump_file, " %s (write-only)", vnode->name ());
815 vnode->call_for_symbol_and_aliases (set_writeonly_bit, &remove_p,
816 true);
819 if (dump_file)
820 fprintf (dump_file, "\n");
821 return remove_p;
824 /* Generate and emit a static constructor or destructor. WHICH must
825 be one of 'I' (for a constructor), 'D' (for a destructor).
826 BODY is a STATEMENT_LIST containing GENERIC
827 statements. PRIORITY is the initialization priority for this
828 constructor or destructor.
830 FINAL specify whether the externally visible name for collect2 should
831 be produced. */
833 static void
834 cgraph_build_static_cdtor_1 (char which, tree body, int priority, bool final)
836 static int counter = 0;
837 char which_buf[16];
838 tree decl, name, resdecl;
840 /* The priority is encoded in the constructor or destructor name.
841 collect2 will sort the names and arrange that they are called at
842 program startup. */
843 if (final)
844 sprintf (which_buf, "%c_%.5d_%d", which, priority, counter++);
845 else
846 /* Proudce sane name but one not recognizable by collect2, just for the
847 case we fail to inline the function. */
848 sprintf (which_buf, "sub_%c_%.5d_%d", which, priority, counter++);
849 name = get_file_function_name (which_buf);
851 decl = build_decl (input_location, FUNCTION_DECL, name,
852 build_function_type_list (void_type_node, NULL_TREE));
853 current_function_decl = decl;
855 resdecl = build_decl (input_location,
856 RESULT_DECL, NULL_TREE, void_type_node);
857 DECL_ARTIFICIAL (resdecl) = 1;
858 DECL_RESULT (decl) = resdecl;
859 DECL_CONTEXT (resdecl) = decl;
861 allocate_struct_function (decl, false);
863 TREE_STATIC (decl) = 1;
864 TREE_USED (decl) = 1;
865 DECL_ARTIFICIAL (decl) = 1;
866 DECL_IGNORED_P (decl) = 1;
867 DECL_NO_INSTRUMENT_FUNCTION_ENTRY_EXIT (decl) = 1;
868 DECL_SAVED_TREE (decl) = body;
869 if (!targetm.have_ctors_dtors && final)
871 TREE_PUBLIC (decl) = 1;
872 DECL_PRESERVE_P (decl) = 1;
874 DECL_UNINLINABLE (decl) = 1;
876 DECL_INITIAL (decl) = make_node (BLOCK);
877 BLOCK_SUPERCONTEXT (DECL_INITIAL (decl)) = decl;
878 TREE_USED (DECL_INITIAL (decl)) = 1;
880 DECL_SOURCE_LOCATION (decl) = input_location;
881 cfun->function_end_locus = input_location;
883 switch (which)
885 case 'I':
886 DECL_STATIC_CONSTRUCTOR (decl) = 1;
887 decl_init_priority_insert (decl, priority);
888 break;
889 case 'D':
890 DECL_STATIC_DESTRUCTOR (decl) = 1;
891 decl_fini_priority_insert (decl, priority);
892 break;
893 default:
894 gcc_unreachable ();
897 gimplify_function_tree (decl);
899 cgraph_node::add_new_function (decl, false);
901 set_cfun (NULL);
902 current_function_decl = NULL;
905 /* Generate and emit a static constructor or destructor. WHICH must
906 be one of 'I' (for a constructor) or 'D' (for a destructor).
907 BODY is a STATEMENT_LIST containing GENERIC
908 statements. PRIORITY is the initialization priority for this
909 constructor or destructor. */
911 void
912 cgraph_build_static_cdtor (char which, tree body, int priority)
914 cgraph_build_static_cdtor_1 (which, body, priority, false);
917 /* When target does not have ctors and dtors, we call all constructor
918 and destructor by special initialization/destruction function
919 recognized by collect2.
921 When we are going to build this function, collect all constructors and
922 destructors and turn them into normal functions. */
924 static void
925 record_cdtor_fn (struct cgraph_node *node, vec<tree> *ctors, vec<tree> *dtors)
927 if (DECL_STATIC_CONSTRUCTOR (node->decl))
928 ctors->safe_push (node->decl);
929 if (DECL_STATIC_DESTRUCTOR (node->decl))
930 dtors->safe_push (node->decl);
931 node = cgraph_node::get (node->decl);
932 DECL_DISREGARD_INLINE_LIMITS (node->decl) = 1;
935 /* Define global constructors/destructor functions for the CDTORS, of
936 which they are LEN. The CDTORS are sorted by initialization
937 priority. If CTOR_P is true, these are constructors; otherwise,
938 they are destructors. */
940 static void
941 build_cdtor (bool ctor_p, const vec<tree> &cdtors)
943 size_t i,j;
944 size_t len = cdtors.length ();
946 i = 0;
947 while (i < len)
949 tree body;
950 tree fn;
951 priority_type priority;
953 priority = 0;
954 body = NULL_TREE;
955 j = i;
958 priority_type p;
959 fn = cdtors[j];
960 p = ctor_p ? DECL_INIT_PRIORITY (fn) : DECL_FINI_PRIORITY (fn);
961 if (j == i)
962 priority = p;
963 else if (p != priority)
964 break;
965 j++;
967 while (j < len);
969 /* When there is only one cdtor and target supports them, do nothing. */
970 if (j == i + 1
971 && targetm.have_ctors_dtors)
973 i++;
974 continue;
976 /* Find the next batch of constructors/destructors with the same
977 initialization priority. */
978 for (;i < j; i++)
980 tree call;
981 fn = cdtors[i];
982 call = build_call_expr (fn, 0);
983 if (ctor_p)
984 DECL_STATIC_CONSTRUCTOR (fn) = 0;
985 else
986 DECL_STATIC_DESTRUCTOR (fn) = 0;
987 /* We do not want to optimize away pure/const calls here.
988 When optimizing, these should be already removed, when not
989 optimizing, we want user to be able to breakpoint in them. */
990 TREE_SIDE_EFFECTS (call) = 1;
991 append_to_statement_list (call, &body);
993 gcc_assert (body != NULL_TREE);
994 /* Generate a function to call all the function of like
995 priority. */
996 cgraph_build_static_cdtor_1 (ctor_p ? 'I' : 'D', body, priority, true);
1000 /* Comparison function for qsort. P1 and P2 are actually of type
1001 "tree *" and point to static constructors. DECL_INIT_PRIORITY is
1002 used to determine the sort order. */
1004 static int
1005 compare_ctor (const void *p1, const void *p2)
1007 tree f1;
1008 tree f2;
1009 int priority1;
1010 int priority2;
1012 f1 = *(const tree *)p1;
1013 f2 = *(const tree *)p2;
1014 priority1 = DECL_INIT_PRIORITY (f1);
1015 priority2 = DECL_INIT_PRIORITY (f2);
1017 if (priority1 < priority2)
1018 return -1;
1019 else if (priority1 > priority2)
1020 return 1;
1021 else
1022 /* Ensure a stable sort. Constructors are executed in backwarding
1023 order to make LTO initialize braries first. */
1024 return DECL_UID (f2) - DECL_UID (f1);
1027 /* Comparison function for qsort. P1 and P2 are actually of type
1028 "tree *" and point to static destructors. DECL_FINI_PRIORITY is
1029 used to determine the sort order. */
1031 static int
1032 compare_dtor (const void *p1, const void *p2)
1034 tree f1;
1035 tree f2;
1036 int priority1;
1037 int priority2;
1039 f1 = *(const tree *)p1;
1040 f2 = *(const tree *)p2;
1041 priority1 = DECL_FINI_PRIORITY (f1);
1042 priority2 = DECL_FINI_PRIORITY (f2);
1044 if (priority1 < priority2)
1045 return -1;
1046 else if (priority1 > priority2)
1047 return 1;
1048 else
1049 /* Ensure a stable sort. */
1050 return DECL_UID (f1) - DECL_UID (f2);
1053 /* Generate functions to call static constructors and destructors
1054 for targets that do not support .ctors/.dtors sections. These
1055 functions have magic names which are detected by collect2. */
1057 static void
1058 build_cdtor_fns (vec<tree> *ctors, vec<tree> *dtors)
1060 if (!ctors->is_empty ())
1062 gcc_assert (!targetm.have_ctors_dtors || in_lto_p);
1063 ctors->qsort (compare_ctor);
1064 build_cdtor (/*ctor_p=*/true, *ctors);
1067 if (!dtors->is_empty ())
1069 gcc_assert (!targetm.have_ctors_dtors || in_lto_p);
1070 dtors->qsort (compare_dtor);
1071 build_cdtor (/*ctor_p=*/false, *dtors);
1075 /* Look for constructors and destructors and produce function calling them.
1076 This is needed for targets not supporting ctors or dtors, but we perform the
1077 transformation also at linktime to merge possibly numerous
1078 constructors/destructors into single function to improve code locality and
1079 reduce size. */
1081 static unsigned int
1082 ipa_cdtor_merge (void)
1084 /* A vector of FUNCTION_DECLs declared as static constructors. */
1085 auto_vec<tree, 20> ctors;
1086 /* A vector of FUNCTION_DECLs declared as static destructors. */
1087 auto_vec<tree, 20> dtors;
1088 struct cgraph_node *node;
1089 FOR_EACH_DEFINED_FUNCTION (node)
1090 if (DECL_STATIC_CONSTRUCTOR (node->decl)
1091 || DECL_STATIC_DESTRUCTOR (node->decl))
1092 record_cdtor_fn (node, &ctors, &dtors);
1093 build_cdtor_fns (&ctors, &dtors);
1094 return 0;
1097 namespace {
1099 const pass_data pass_data_ipa_cdtor_merge =
1101 IPA_PASS, /* type */
1102 "cdtor", /* name */
1103 OPTGROUP_NONE, /* optinfo_flags */
1104 TV_CGRAPHOPT, /* tv_id */
1105 0, /* properties_required */
1106 0, /* properties_provided */
1107 0, /* properties_destroyed */
1108 0, /* todo_flags_start */
1109 0, /* todo_flags_finish */
1112 class pass_ipa_cdtor_merge : public ipa_opt_pass_d
1114 public:
1115 pass_ipa_cdtor_merge (gcc::context *ctxt)
1116 : ipa_opt_pass_d (pass_data_ipa_cdtor_merge, ctxt,
1117 NULL, /* generate_summary */
1118 NULL, /* write_summary */
1119 NULL, /* read_summary */
1120 NULL, /* write_optimization_summary */
1121 NULL, /* read_optimization_summary */
1122 NULL, /* stmt_fixup */
1123 0, /* function_transform_todo_flags_start */
1124 NULL, /* function_transform */
1125 NULL) /* variable_transform */
1128 /* opt_pass methods: */
1129 virtual bool gate (function *);
1130 virtual unsigned int execute (function *) { return ipa_cdtor_merge (); }
1132 }; // class pass_ipa_cdtor_merge
1134 bool
1135 pass_ipa_cdtor_merge::gate (function *)
1137 /* Perform the pass when we have no ctors/dtors support
1138 or at LTO time to merge multiple constructors into single
1139 function. */
1140 return !targetm.have_ctors_dtors || in_lto_p;
1143 } // anon namespace
1145 ipa_opt_pass_d *
1146 make_pass_ipa_cdtor_merge (gcc::context *ctxt)
1148 return new pass_ipa_cdtor_merge (ctxt);
1151 /* Invalid pointer representing BOTTOM for single user dataflow. */
1152 #define BOTTOM ((cgraph_node *)(size_t) 2)
1154 /* Meet operation for single user dataflow.
1155 Here we want to associate variables with sigle function that may access it.
1157 FUNCTION is current single user of a variable, VAR is variable that uses it.
1158 Latttice is stored in SINGLE_USER_MAP.
1160 We represent:
1161 - TOP by no entry in SIGNLE_USER_MAP
1162 - BOTTOM by BOTTOM in AUX pointer (to save lookups)
1163 - known single user by cgraph pointer in SINGLE_USER_MAP. */
1165 cgraph_node *
1166 meet (cgraph_node *function, varpool_node *var,
1167 hash_map<varpool_node *, cgraph_node *> &single_user_map)
1169 struct cgraph_node *user, **f;
1171 if (var->aux == BOTTOM)
1172 return BOTTOM;
1174 f = single_user_map.get (var);
1175 if (!f)
1176 return function;
1177 user = *f;
1178 if (!function)
1179 return user;
1180 else if (function != user)
1181 return BOTTOM;
1182 else
1183 return function;
1186 /* Propagation step of single-use dataflow.
1188 Check all uses of VNODE and see if they are used by single function FUNCTION.
1189 SINGLE_USER_MAP represents the dataflow lattice. */
1191 cgraph_node *
1192 propagate_single_user (varpool_node *vnode, cgraph_node *function,
1193 hash_map<varpool_node *, cgraph_node *> &single_user_map)
1195 int i;
1196 struct ipa_ref *ref;
1198 gcc_assert (!vnode->externally_visible);
1200 /* If node is an alias, first meet with its target. */
1201 if (vnode->alias)
1202 function = meet (function, vnode->get_alias_target (), single_user_map);
1204 /* Check all users and see if they correspond to a single function. */
1205 for (i = 0; vnode->iterate_referring (i, ref) && function != BOTTOM; i++)
1207 struct cgraph_node *cnode = dyn_cast <cgraph_node *> (ref->referring);
1208 if (cnode)
1210 if (cnode->global.inlined_to)
1211 cnode = cnode->global.inlined_to;
1212 if (!function)
1213 function = cnode;
1214 else if (function != cnode)
1215 function = BOTTOM;
1217 else
1218 function = meet (function, dyn_cast <varpool_node *> (ref->referring),
1219 single_user_map);
1221 return function;
1224 /* Pass setting used_by_single_function flag.
1225 This flag is set on variable when there is only one function that may
1226 possibly referr to it. */
1228 static unsigned int
1229 ipa_single_use (void)
1231 varpool_node *first = (varpool_node *) (void *) 1;
1232 varpool_node *var;
1233 hash_map<varpool_node *, cgraph_node *> single_user_map;
1235 FOR_EACH_DEFINED_VARIABLE (var)
1236 if (!var->all_refs_explicit_p ())
1237 var->aux = BOTTOM;
1238 else
1240 /* Enqueue symbol for dataflow. */
1241 var->aux = first;
1242 first = var;
1245 /* The actual dataflow. */
1247 while (first != (void *) 1)
1249 cgraph_node *user, *orig_user, **f;
1251 var = first;
1252 first = (varpool_node *)first->aux;
1254 f = single_user_map.get (var);
1255 if (f)
1256 orig_user = *f;
1257 else
1258 orig_user = NULL;
1259 user = propagate_single_user (var, orig_user, single_user_map);
1261 gcc_checking_assert (var->aux != BOTTOM);
1263 /* If user differs, enqueue all references. */
1264 if (user != orig_user)
1266 unsigned int i;
1267 ipa_ref *ref;
1269 single_user_map.put (var, user);
1271 /* Enqueue all aliases for re-processing. */
1272 for (i = 0; var->iterate_direct_aliases (i, ref); i++)
1273 if (!ref->referring->aux)
1275 ref->referring->aux = first;
1276 first = dyn_cast <varpool_node *> (ref->referring);
1278 /* Enqueue all users for re-processing. */
1279 for (i = 0; var->iterate_reference (i, ref); i++)
1280 if (!ref->referred->aux
1281 && ref->referred->definition
1282 && is_a <varpool_node *> (ref->referred))
1284 ref->referred->aux = first;
1285 first = dyn_cast <varpool_node *> (ref->referred);
1288 /* If user is BOTTOM, just punt on this var. */
1289 if (user == BOTTOM)
1290 var->aux = BOTTOM;
1291 else
1292 var->aux = NULL;
1294 else
1295 var->aux = NULL;
1298 FOR_EACH_DEFINED_VARIABLE (var)
1300 if (var->aux != BOTTOM)
1302 /* Not having the single user known means that the VAR is
1303 unreachable. Either someone forgot to remove unreachable
1304 variables or the reachability here is wrong. */
1306 gcc_checking_assert (single_user_map.get (var));
1308 if (dump_file)
1310 fprintf (dump_file, "Variable %s is used by single function\n",
1311 var->dump_name ());
1313 var->used_by_single_function = true;
1315 var->aux = NULL;
1317 return 0;
1320 namespace {
1322 const pass_data pass_data_ipa_single_use =
1324 IPA_PASS, /* type */
1325 "single-use", /* name */
1326 OPTGROUP_NONE, /* optinfo_flags */
1327 TV_CGRAPHOPT, /* tv_id */
1328 0, /* properties_required */
1329 0, /* properties_provided */
1330 0, /* properties_destroyed */
1331 0, /* todo_flags_start */
1332 0, /* todo_flags_finish */
1335 class pass_ipa_single_use : public ipa_opt_pass_d
1337 public:
1338 pass_ipa_single_use (gcc::context *ctxt)
1339 : ipa_opt_pass_d (pass_data_ipa_single_use, ctxt,
1340 NULL, /* generate_summary */
1341 NULL, /* write_summary */
1342 NULL, /* read_summary */
1343 NULL, /* write_optimization_summary */
1344 NULL, /* read_optimization_summary */
1345 NULL, /* stmt_fixup */
1346 0, /* function_transform_todo_flags_start */
1347 NULL, /* function_transform */
1348 NULL) /* variable_transform */
1351 /* opt_pass methods: */
1352 virtual unsigned int execute (function *) { return ipa_single_use (); }
1354 }; // class pass_ipa_single_use
1356 } // anon namespace
1358 ipa_opt_pass_d *
1359 make_pass_ipa_single_use (gcc::context *ctxt)
1361 return new pass_ipa_single_use (ctxt);
1364 /* Materialize all clones. */
1366 namespace {
1368 const pass_data pass_data_materialize_all_clones =
1370 SIMPLE_IPA_PASS, /* type */
1371 "materialize-all-clones", /* name */
1372 OPTGROUP_NONE, /* optinfo_flags */
1373 TV_IPA_OPT, /* tv_id */
1374 0, /* properties_required */
1375 0, /* properties_provided */
1376 0, /* properties_destroyed */
1377 0, /* todo_flags_start */
1378 0, /* todo_flags_finish */
1381 class pass_materialize_all_clones : public simple_ipa_opt_pass
1383 public:
1384 pass_materialize_all_clones (gcc::context *ctxt)
1385 : simple_ipa_opt_pass (pass_data_materialize_all_clones, ctxt)
1388 /* opt_pass methods: */
1389 virtual unsigned int execute (function *)
1391 symtab->materialize_all_clones ();
1392 return 0;
1395 }; // class pass_materialize_all_clones
1397 } // anon namespace
1399 simple_ipa_opt_pass *
1400 make_pass_materialize_all_clones (gcc::context *ctxt)
1402 return new pass_materialize_all_clones (ctxt);