match_asm_constraints: Use copy_rtx where needed (PR88001)
[official-gcc.git] / gcc / cgraph.h
blobb8e23cc338aec7ead0c68240a04906ba5b1ecd61
1 /* Callgraph handling code.
2 Copyright (C) 2003-2018 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
10 version.
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
15 for more details.
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/>. */
21 #ifndef GCC_CGRAPH_H
22 #define GCC_CGRAPH_H
24 #include "profile-count.h"
25 #include "ipa-ref.h"
26 #include "plugin-api.h"
28 extern void debuginfo_early_init (void);
29 extern void debuginfo_init (void);
30 extern void debuginfo_fini (void);
31 extern void debuginfo_start (void);
32 extern void debuginfo_stop (void);
33 extern void debuginfo_early_start (void);
34 extern void debuginfo_early_stop (void);
36 class ipa_opt_pass_d;
37 typedef ipa_opt_pass_d *ipa_opt_pass;
39 /* Symbol table consists of functions and variables.
40 TODO: add labels and CONST_DECLs. */
41 enum symtab_type
43 SYMTAB_SYMBOL,
44 SYMTAB_FUNCTION,
45 SYMTAB_VARIABLE
48 /* Section names are stored as reference counted strings in GGC safe hashtable
49 (to make them survive through PCH). */
51 struct GTY((for_user)) section_hash_entry
53 int ref_count;
54 char *name; /* As long as this datastructure stays in GGC, we can not put
55 string at the tail of structure of GGC dies in horrible
56 way */
59 struct section_name_hasher : ggc_ptr_hash<section_hash_entry>
61 typedef const char *compare_type;
63 static hashval_t hash (section_hash_entry *);
64 static bool equal (section_hash_entry *, const char *);
67 enum availability
69 /* Not yet set by cgraph_function_body_availability. */
70 AVAIL_UNSET,
71 /* Function body/variable initializer is unknown. */
72 AVAIL_NOT_AVAILABLE,
73 /* Function body/variable initializer is known but might be replaced
74 by a different one from other compilation unit and thus needs to
75 be dealt with a care. Like AVAIL_NOT_AVAILABLE it can have
76 arbitrary side effects on escaping variables and functions, while
77 like AVAILABLE it might access static variables. */
78 AVAIL_INTERPOSABLE,
79 /* Function body/variable initializer is known and will be used in final
80 program. */
81 AVAIL_AVAILABLE,
82 /* Function body/variable initializer is known and all it's uses are
83 explicitly visible within current unit (ie it's address is never taken and
84 it is not exported to other units). Currently used only for functions. */
85 AVAIL_LOCAL
88 /* Classification of symbols WRT partitioning. */
89 enum symbol_partitioning_class
91 /* External declarations are ignored by partitioning algorithms and they are
92 added into the boundary later via compute_ltrans_boundary. */
93 SYMBOL_EXTERNAL,
94 /* Partitioned symbols are pur into one of partitions. */
95 SYMBOL_PARTITION,
96 /* Duplicated symbols (such as comdat or constant pool references) are
97 copied into every node needing them via add_symbol_to_partition. */
98 SYMBOL_DUPLICATE
101 /* Base of all entries in the symbol table.
102 The symtab_node is inherited by cgraph and varpol nodes. */
103 class GTY((desc ("%h.type"), tag ("SYMTAB_SYMBOL"),
104 chain_next ("%h.next"), chain_prev ("%h.previous")))
105 symtab_node
107 public:
108 friend class symbol_table;
110 /* Return name. */
111 const char *name () const;
113 /* Return dump name. */
114 const char *dump_name () const;
116 /* Return asm name. */
117 const char *asm_name () const;
119 /* Return dump name with assembler name. */
120 const char *dump_asm_name () const;
122 /* Add node into symbol table. This function is not used directly, but via
123 cgraph/varpool node creation routines. */
124 void register_symbol (void);
126 /* Remove symbol from symbol table. */
127 void remove (void);
129 /* Dump symtab node to F. */
130 void dump (FILE *f);
132 /* Dump symtab node to stderr. */
133 void DEBUG_FUNCTION debug (void);
135 /* Verify consistency of node. */
136 void DEBUG_FUNCTION verify (void);
138 /* Return ipa reference from this symtab_node to
139 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
140 of the use and STMT the statement (if it exists). */
141 ipa_ref *create_reference (symtab_node *referred_node,
142 enum ipa_ref_use use_type);
144 /* Return ipa reference from this symtab_node to
145 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
146 of the use and STMT the statement (if it exists). */
147 ipa_ref *create_reference (symtab_node *referred_node,
148 enum ipa_ref_use use_type, gimple *stmt);
150 /* If VAL is a reference to a function or a variable, add a reference from
151 this symtab_node to the corresponding symbol table node. Return the new
152 reference or NULL if none was created. */
153 ipa_ref *maybe_create_reference (tree val, gimple *stmt);
155 /* Clone all references from symtab NODE to this symtab_node. */
156 void clone_references (symtab_node *node);
158 /* Remove all stmt references in non-speculative references.
159 Those are not maintained during inlining & clonning.
160 The exception are speculative references that are updated along
161 with callgraph edges associated with them. */
162 void clone_referring (symtab_node *node);
164 /* Clone reference REF to this symtab_node and set its stmt to STMT. */
165 ipa_ref *clone_reference (ipa_ref *ref, gimple *stmt);
167 /* Find the structure describing a reference to REFERRED_NODE
168 and associated with statement STMT. */
169 ipa_ref *find_reference (symtab_node *referred_node, gimple *stmt,
170 unsigned int lto_stmt_uid);
172 /* Remove all references that are associated with statement STMT. */
173 void remove_stmt_references (gimple *stmt);
175 /* Remove all stmt references in non-speculative references.
176 Those are not maintained during inlining & clonning.
177 The exception are speculative references that are updated along
178 with callgraph edges associated with them. */
179 void clear_stmts_in_references (void);
181 /* Remove all references in ref list. */
182 void remove_all_references (void);
184 /* Remove all referring items in ref list. */
185 void remove_all_referring (void);
187 /* Dump references in ref list to FILE. */
188 void dump_references (FILE *file);
190 /* Dump referring in list to FILE. */
191 void dump_referring (FILE *);
193 /* Get number of references for this node. */
194 inline unsigned num_references (void)
196 return ref_list.references ? ref_list.references->length () : 0;
199 /* Iterates I-th reference in the list, REF is also set. */
200 ipa_ref *iterate_reference (unsigned i, ipa_ref *&ref);
202 /* Iterates I-th referring item in the list, REF is also set. */
203 ipa_ref *iterate_referring (unsigned i, ipa_ref *&ref);
205 /* Iterates I-th referring alias item in the list, REF is also set. */
206 ipa_ref *iterate_direct_aliases (unsigned i, ipa_ref *&ref);
208 /* Return true if symtab node and TARGET represents
209 semantically equivalent symbols. */
210 bool semantically_equivalent_p (symtab_node *target);
212 /* Classify symbol symtab node for partitioning. */
213 enum symbol_partitioning_class get_partitioning_class (void);
215 /* Return comdat group. */
216 tree get_comdat_group ()
218 return x_comdat_group;
221 /* Return comdat group as identifier_node. */
222 tree get_comdat_group_id ()
224 if (x_comdat_group && TREE_CODE (x_comdat_group) != IDENTIFIER_NODE)
225 x_comdat_group = DECL_ASSEMBLER_NAME (x_comdat_group);
226 return x_comdat_group;
229 /* Set comdat group. */
230 void set_comdat_group (tree group)
232 gcc_checking_assert (!group || TREE_CODE (group) == IDENTIFIER_NODE
233 || DECL_P (group));
234 x_comdat_group = group;
237 /* Return section as string. */
238 const char * get_section ()
240 if (!x_section)
241 return NULL;
242 return x_section->name;
245 /* Remove node from same comdat group. */
246 void remove_from_same_comdat_group (void);
248 /* Add this symtab_node to the same comdat group that OLD is in. */
249 void add_to_same_comdat_group (symtab_node *old_node);
251 /* Dissolve the same_comdat_group list in which NODE resides. */
252 void dissolve_same_comdat_group_list (void);
254 /* Return true when symtab_node is known to be used from other (non-LTO)
255 object file. Known only when doing LTO via linker plugin. */
256 bool used_from_object_file_p (void);
258 /* Walk the alias chain to return the symbol NODE is alias of.
259 If NODE is not an alias, return NODE.
260 When AVAILABILITY is non-NULL, get minimal availability in the chain.
261 When REF is non-NULL, assume that reference happens in symbol REF
262 when determining the availability. */
263 symtab_node *ultimate_alias_target (enum availability *avail = NULL,
264 struct symtab_node *ref = NULL);
266 /* Return next reachable static symbol with initializer after NODE. */
267 inline symtab_node *next_defined_symbol (void);
269 /* Add reference recording that symtab node is alias of TARGET.
270 If TRANSPARENT is true make the alias to be transparent alias.
271 The function can fail in the case of aliasing cycles; in this case
272 it returns false. */
273 bool resolve_alias (symtab_node *target, bool transparent = false);
275 /* C++ FE sometimes change linkage flags after producing same
276 body aliases. */
277 void fixup_same_cpp_alias_visibility (symtab_node *target);
279 /* Call callback on symtab node and aliases associated to this node.
280 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
281 skipped. */
282 bool call_for_symbol_and_aliases (bool (*callback) (symtab_node *, void *),
283 void *data,
284 bool include_overwrite);
286 /* If node can not be interposable by static or dynamic linker to point to
287 different definition, return this symbol. Otherwise look for alias with
288 such property and if none exists, introduce new one. */
289 symtab_node *noninterposable_alias (void);
291 /* Return node that alias is aliasing. */
292 inline symtab_node *get_alias_target (void);
294 /* Set section for symbol and its aliases. */
295 void set_section (const char *section);
297 /* Set section, do not recurse into aliases.
298 When one wants to change section of symbol and its aliases,
299 use set_section. */
300 void set_section_for_node (const char *section);
302 /* Set initialization priority to PRIORITY. */
303 void set_init_priority (priority_type priority);
305 /* Return the initialization priority. */
306 priority_type get_init_priority ();
308 /* Return availability of NODE when referenced from REF. */
309 enum availability get_availability (symtab_node *ref = NULL);
311 /* Return true if NODE binds to current definition in final executable
312 when referenced from REF. If REF is NULL return conservative value
313 for any reference. */
314 bool binds_to_current_def_p (symtab_node *ref = NULL);
316 /* Make DECL local. */
317 void make_decl_local (void);
319 /* Copy visibility from N. */
320 void copy_visibility_from (symtab_node *n);
322 /* Return desired alignment of the definition. This is NOT alignment useful
323 to access THIS, because THIS may be interposable and DECL_ALIGN should
324 be used instead. It however must be guaranteed when output definition
325 of THIS. */
326 unsigned int definition_alignment ();
328 /* Return true if alignment can be increased. */
329 bool can_increase_alignment_p ();
331 /* Increase alignment of symbol to ALIGN. */
332 void increase_alignment (unsigned int align);
334 /* Return true if list contains an alias. */
335 bool has_aliases_p (void);
337 /* Return true when the symbol is real symbol, i.e. it is not inline clone
338 or abstract function kept for debug info purposes only. */
339 bool real_symbol_p (void);
341 /* Return true when the symbol needs to be output to the LTO symbol table. */
342 bool output_to_lto_symbol_table_p (void);
344 /* Determine if symbol declaration is needed. That is, visible to something
345 either outside this translation unit, something magic in the system
346 configury. This function is used just during symbol creation. */
347 bool needed_p (void);
349 /* Return true if this symbol is a function from the C frontend specified
350 directly in RTL form (with "__RTL"). */
351 bool native_rtl_p () const;
353 /* Return true when there are references to the node. */
354 bool referred_to_p (bool include_self = true);
356 /* Return true if symbol can be discarded by linker from the binary.
357 Assume that symbol is used (so there is no need to take into account
358 garbage collecting linkers)
360 This can happen for comdats, commons and weaks when they are previaled
361 by other definition at static linking time. */
362 inline bool
363 can_be_discarded_p (void)
365 return (DECL_EXTERNAL (decl)
366 || ((get_comdat_group ()
367 || DECL_COMMON (decl)
368 || (DECL_SECTION_NAME (decl) && DECL_WEAK (decl)))
369 && ((resolution != LDPR_PREVAILING_DEF
370 && resolution != LDPR_PREVAILING_DEF_IRONLY_EXP)
371 || flag_incremental_link)
372 && resolution != LDPR_PREVAILING_DEF_IRONLY));
375 /* Return true if NODE is local to a particular COMDAT group, and must not
376 be named from outside the COMDAT. This is used for C++ decloned
377 constructors. */
378 inline bool comdat_local_p (void)
380 return (same_comdat_group && !TREE_PUBLIC (decl));
383 /* Return true if ONE and TWO are part of the same COMDAT group. */
384 inline bool in_same_comdat_group_p (symtab_node *target);
386 /* Return true if symbol is known to be nonzero. */
387 bool nonzero_address ();
389 /* Return 0 if symbol is known to have different address than S2,
390 Return 1 if symbol is known to have same address as S2,
391 return 2 otherwise.
393 If MEMORY_ACCESSED is true, assume that both memory pointer to THIS
394 and S2 is going to be accessed. This eliminates the situations when
395 either THIS or S2 is NULL and is seful for comparing bases when deciding
396 about memory aliasing. */
397 int equal_address_to (symtab_node *s2, bool memory_accessed = false);
399 /* Return true if symbol's address may possibly be compared to other
400 symbol's address. */
401 bool address_matters_p ();
403 /* Return true if NODE's address can be compared. This use properties
404 of NODE only and does not look if the address is actually taken in
405 interesting way. For that use ADDRESS_MATTERS_P instead. */
406 bool address_can_be_compared_p (void);
408 /* Return symbol table node associated with DECL, if any,
409 and NULL otherwise. */
410 static inline symtab_node *get (const_tree decl)
412 /* Check that we are called for sane type of object - functions
413 and static or external variables. */
414 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL
415 || (TREE_CODE (decl) == VAR_DECL
416 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl)
417 || in_lto_p)));
418 /* Check that the mapping is sane - perhaps this check can go away,
419 but at the moment frontends tends to corrupt the mapping by calling
420 memcpy/memset on the tree nodes. */
421 gcc_checking_assert (!decl->decl_with_vis.symtab_node
422 || decl->decl_with_vis.symtab_node->decl == decl);
423 return decl->decl_with_vis.symtab_node;
426 /* Try to find a symtab node for declaration DECL and if it does not
427 exist or if it corresponds to an inline clone, create a new one. */
428 static inline symtab_node * get_create (tree node);
430 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
431 Return NULL if there's no such node. */
432 static symtab_node *get_for_asmname (const_tree asmname);
434 /* Verify symbol table for internal consistency. */
435 static DEBUG_FUNCTION void verify_symtab_nodes (void);
437 /* Perform internal consistency checks, if they are enabled. */
438 static inline void checking_verify_symtab_nodes (void);
440 /* Type of the symbol. */
441 ENUM_BITFIELD (symtab_type) type : 8;
443 /* The symbols resolution. */
444 ENUM_BITFIELD (ld_plugin_symbol_resolution) resolution : 8;
446 /*** Flags representing the symbol type. ***/
448 /* True when symbol corresponds to a definition in current unit.
449 set via finalize_function or finalize_decl */
450 unsigned definition : 1;
451 /* True when symbol is an alias.
452 Set by ssemble_alias. */
453 unsigned alias : 1;
454 /* When true the alias is translated into its target symbol either by GCC
455 or assembler (it also may just be a duplicate declaration of the same
456 linker name).
458 Currently transparent aliases come in three different flavors
459 - aliases having the same assembler name as their target (aka duplicated
460 declarations). In this case the assembler names compare via
461 assembler_names_equal_p and weakref is false
462 - aliases that are renamed at a time being output to final file
463 by varasm.c. For those DECL_ASSEMBLER_NAME have
464 IDENTIFIER_TRANSPARENT_ALIAS set and thus also their assembler
465 name must be unique.
466 Weakrefs belong to this cateogry when we target assembler without
467 .weakref directive.
468 - weakrefs that are renamed by assembler via .weakref directive.
469 In this case the alias may or may not be definition (depending if
470 target declaration was seen by the compiler), weakref is set.
471 Unless we are before renaming statics, assembler names are different.
473 Given that we now support duplicate declarations, the second option is
474 redundant and will be removed. */
475 unsigned transparent_alias : 1;
476 /* True when alias is a weakref. */
477 unsigned weakref : 1;
478 /* C++ frontend produce same body aliases and extra name aliases for
479 virtual functions and vtables that are obviously equivalent.
480 Those aliases are bit special, especially because C++ frontend
481 visibility code is so ugly it can not get them right at first time
482 and their visibility needs to be copied from their "masters" at
483 the end of parsing. */
484 unsigned cpp_implicit_alias : 1;
485 /* Set once the definition was analyzed. The list of references and
486 other properties are built during analysis. */
487 unsigned analyzed : 1;
488 /* Set for write-only variables. */
489 unsigned writeonly : 1;
490 /* Visibility of symbol was used for further optimization; do not
491 permit further changes. */
492 unsigned refuse_visibility_changes : 1;
494 /*** Visibility and linkage flags. ***/
496 /* Set when function is visible by other units. */
497 unsigned externally_visible : 1;
498 /* Don't reorder to other symbols having this set. */
499 unsigned no_reorder : 1;
500 /* The symbol will be assumed to be used in an invisible way (like
501 by an toplevel asm statement). */
502 unsigned force_output : 1;
503 /* Like FORCE_OUTPUT, but in the case it is ABI requiring the symbol to be
504 exported. Unlike FORCE_OUTPUT this flag gets cleared to symbols promoted
505 to static and it does not inhibit optimization. */
506 unsigned forced_by_abi : 1;
507 /* True when the name is known to be unique and thus it does not need mangling. */
508 unsigned unique_name : 1;
509 /* Specify whether the section was set by user or by
510 compiler via -ffunction-sections. */
511 unsigned implicit_section : 1;
512 /* True when body and other characteristics have been removed by
513 symtab_remove_unreachable_nodes. */
514 unsigned body_removed : 1;
516 /*** WHOPR Partitioning flags.
517 These flags are used at ltrans stage when only part of the callgraph is
518 available. ***/
520 /* Set when variable is used from other LTRANS partition. */
521 unsigned used_from_other_partition : 1;
522 /* Set when function is available in the other LTRANS partition.
523 During WPA output it is used to mark nodes that are present in
524 multiple partitions. */
525 unsigned in_other_partition : 1;
529 /*** other flags. ***/
531 /* Set when symbol has address taken. */
532 unsigned address_taken : 1;
533 /* Set when init priority is set. */
534 unsigned in_init_priority_hash : 1;
536 /* Set when symbol needs to be streamed into LTO bytecode for LTO, or in case
537 of offloading, for separate compilation for a different target. */
538 unsigned need_lto_streaming : 1;
540 /* Set when symbol can be streamed into bytecode for offloading. */
541 unsigned offloadable : 1;
543 /* Set when symbol is an IFUNC resolver. */
544 unsigned ifunc_resolver : 1;
547 /* Ordering of all symtab entries. */
548 int order;
550 /* Declaration representing the symbol. */
551 tree decl;
553 /* Linked list of symbol table entries starting with symtab_nodes. */
554 symtab_node *next;
555 symtab_node *previous;
557 /* Linked list of symbols with the same asm name. There may be multiple
558 entries for single symbol name during LTO, because symbols are renamed
559 only after partitioning.
561 Because inline clones are kept in the assembler name has, they also produce
562 duplicate entries.
564 There are also several long standing bugs where frontends and builtin
565 code produce duplicated decls. */
566 symtab_node *next_sharing_asm_name;
567 symtab_node *previous_sharing_asm_name;
569 /* Circular list of nodes in the same comdat group if non-NULL. */
570 symtab_node *same_comdat_group;
572 /* Vectors of referring and referenced entities. */
573 ipa_ref_list ref_list;
575 /* Alias target. May be either DECL pointer or ASSEMBLER_NAME pointer
576 depending to what was known to frontend on the creation time.
577 Once alias is resolved, this pointer become NULL. */
578 tree alias_target;
580 /* File stream where this node is being written to. */
581 struct lto_file_decl_data * lto_file_data;
583 PTR GTY ((skip)) aux;
585 /* Comdat group the symbol is in. Can be private if GGC allowed that. */
586 tree x_comdat_group;
588 /* Section name. Again can be private, if allowed. */
589 section_hash_entry *x_section;
591 protected:
592 /* Dump base fields of symtab nodes to F. Not to be used directly. */
593 void dump_base (FILE *);
595 /* Verify common part of symtab node. */
596 bool DEBUG_FUNCTION verify_base (void);
598 /* Remove node from symbol table. This function is not used directly, but via
599 cgraph/varpool node removal routines. */
600 void unregister (void);
602 /* Return the initialization and finalization priority information for
603 DECL. If there is no previous priority information, a freshly
604 allocated structure is returned. */
605 struct symbol_priority_map *priority_info (void);
607 /* Worker for call_for_symbol_and_aliases_1. */
608 bool call_for_symbol_and_aliases_1 (bool (*callback) (symtab_node *, void *),
609 void *data,
610 bool include_overwrite);
611 private:
612 /* Worker for set_section. */
613 static bool set_section (symtab_node *n, void *s);
615 /* Worker for symtab_resolve_alias. */
616 static bool set_implicit_section (symtab_node *n, void *);
618 /* Worker searching noninterposable alias. */
619 static bool noninterposable_alias (symtab_node *node, void *data);
621 /* Worker for ultimate_alias_target. */
622 symtab_node *ultimate_alias_target_1 (enum availability *avail = NULL,
623 symtab_node *ref = NULL);
625 /* Get dump name with normal or assembly name. */
626 const char *get_dump_name (bool asm_name_p) const;
629 inline void
630 symtab_node::checking_verify_symtab_nodes (void)
632 if (flag_checking)
633 symtab_node::verify_symtab_nodes ();
636 /* Walk all aliases for NODE. */
637 #define FOR_EACH_ALIAS(node, alias) \
638 for (unsigned x_i = 0; node->iterate_direct_aliases (x_i, alias); x_i++)
640 /* This is the information that is put into the cgraph local structure
641 to recover a function. */
642 struct lto_file_decl_data;
644 extern const char * const cgraph_availability_names[];
645 extern const char * const ld_plugin_symbol_resolution_names[];
646 extern const char * const tls_model_names[];
648 /* Sub-structure of cgraph_node. Holds information about thunk, used only for
649 same body aliases.
651 Thunks are basically wrappers around methods which are introduced in case
652 of multiple inheritance in order to adjust the value of the "this" pointer
653 or of the returned value.
655 In the case of this-adjusting thunks, each back-end can override the
656 can_output_mi_thunk/output_mi_thunk target hooks to generate a minimal thunk
657 (with a tail call for instance) directly as assembly. For the default hook
658 or for the case where the can_output_mi_thunk hooks return false, the thunk
659 is gimplified and lowered using the regular machinery. */
661 struct GTY(()) cgraph_thunk_info {
662 /* Offset used to adjust "this". */
663 HOST_WIDE_INT fixed_offset;
665 /* Offset in the virtual table to get the offset to adjust "this". Valid iff
666 VIRTUAL_OFFSET_P is true. */
667 HOST_WIDE_INT virtual_value;
669 /* Offset from "this" to get the offset to adjust "this". Zero means: this
670 offset is to be ignored. */
671 HOST_WIDE_INT indirect_offset;
673 /* Thunk target, i.e. the method that this thunk wraps. Depending on the
674 TARGET_USE_LOCAL_THUNK_ALIAS_P macro, this may have to be a new alias. */
675 tree alias;
677 /* Nonzero for a "this" adjusting thunk and zero for a result adjusting
678 thunk. */
679 bool this_adjusting;
681 /* If true, this thunk is what we call a virtual thunk. In this case:
682 * for this-adjusting thunks, after the FIXED_OFFSET based adjustment is
683 done, add to the result the offset found in the vtable at:
684 vptr + VIRTUAL_VALUE
685 * for result-adjusting thunks, the FIXED_OFFSET adjustment is done after
686 the virtual one. */
687 bool virtual_offset_p;
689 /* ??? True for special kind of thunks, seems related to instrumentation. */
690 bool add_pointer_bounds_args;
692 /* Set to true when alias node (the cgraph_node to which this struct belong)
693 is a thunk. Access to any other fields is invalid if this is false. */
694 bool thunk_p;
697 /* Information about the function collected locally.
698 Available after function is analyzed. */
700 struct GTY(()) cgraph_local_info {
701 /* Set when function is visible in current compilation unit only and
702 its address is never taken. */
703 unsigned local : 1;
705 /* False when there is something makes versioning impossible. */
706 unsigned versionable : 1;
708 /* False when function calling convention and signature can not be changed.
709 This is the case when __builtin_apply_args is used. */
710 unsigned can_change_signature : 1;
712 /* True when the function has been originally extern inline, but it is
713 redefined now. */
714 unsigned redefined_extern_inline : 1;
716 /* True if the function may enter serial irrevocable mode. */
717 unsigned tm_may_enter_irr : 1;
720 /* Information about the function that needs to be computed globally
721 once compilation is finished. Available only with -funit-at-a-time. */
723 struct GTY(()) cgraph_global_info {
724 /* For inline clones this points to the function they will be
725 inlined into. */
726 cgraph_node *inlined_to;
729 /* Represent which DECL tree (or reference to such tree)
730 will be replaced by another tree while versioning. */
731 struct GTY(()) ipa_replace_map
733 /* The tree that will be replaced. */
734 tree old_tree;
735 /* The new (replacing) tree. */
736 tree new_tree;
737 /* Parameter number to replace, when old_tree is NULL. */
738 int parm_num;
739 /* True when a substitution should be done, false otherwise. */
740 bool replace_p;
741 /* True when we replace a reference to old_tree. */
742 bool ref_p;
745 struct GTY(()) cgraph_clone_info
747 vec<ipa_replace_map *, va_gc> *tree_map;
748 bitmap args_to_skip;
749 bitmap combined_args_to_skip;
752 enum cgraph_simd_clone_arg_type
754 SIMD_CLONE_ARG_TYPE_VECTOR,
755 SIMD_CLONE_ARG_TYPE_UNIFORM,
756 /* These are only for integer/pointer arguments passed by value. */
757 SIMD_CLONE_ARG_TYPE_LINEAR_CONSTANT_STEP,
758 SIMD_CLONE_ARG_TYPE_LINEAR_VARIABLE_STEP,
759 /* These 6 are only for reference type arguments or arguments passed
760 by reference. */
761 SIMD_CLONE_ARG_TYPE_LINEAR_REF_CONSTANT_STEP,
762 SIMD_CLONE_ARG_TYPE_LINEAR_REF_VARIABLE_STEP,
763 SIMD_CLONE_ARG_TYPE_LINEAR_UVAL_CONSTANT_STEP,
764 SIMD_CLONE_ARG_TYPE_LINEAR_UVAL_VARIABLE_STEP,
765 SIMD_CLONE_ARG_TYPE_LINEAR_VAL_CONSTANT_STEP,
766 SIMD_CLONE_ARG_TYPE_LINEAR_VAL_VARIABLE_STEP,
767 SIMD_CLONE_ARG_TYPE_MASK
770 /* Function arguments in the original function of a SIMD clone.
771 Supplementary data for `struct simd_clone'. */
773 struct GTY(()) cgraph_simd_clone_arg {
774 /* Original function argument as it originally existed in
775 DECL_ARGUMENTS. */
776 tree orig_arg;
778 /* orig_arg's function (or for extern functions type from
779 TYPE_ARG_TYPES). */
780 tree orig_type;
782 /* If argument is a vector, this holds the vector version of
783 orig_arg that after adjusting the argument types will live in
784 DECL_ARGUMENTS. Otherwise, this is NULL.
786 This basically holds:
787 vector(simdlen) __typeof__(orig_arg) new_arg. */
788 tree vector_arg;
790 /* vector_arg's type (or for extern functions new vector type. */
791 tree vector_type;
793 /* If argument is a vector, this holds the array where the simd
794 argument is held while executing the simd clone function. This
795 is a local variable in the cloned function. Its content is
796 copied from vector_arg upon entry to the clone.
798 This basically holds:
799 __typeof__(orig_arg) simd_array[simdlen]. */
800 tree simd_array;
802 /* A SIMD clone's argument can be either linear (constant or
803 variable), uniform, or vector. */
804 enum cgraph_simd_clone_arg_type arg_type;
806 /* For arg_type SIMD_CLONE_ARG_TYPE_LINEAR_*CONSTANT_STEP this is
807 the constant linear step, if arg_type is
808 SIMD_CLONE_ARG_TYPE_LINEAR_*VARIABLE_STEP, this is index of
809 the uniform argument holding the step, otherwise 0. */
810 HOST_WIDE_INT linear_step;
812 /* Variable alignment if available, otherwise 0. */
813 unsigned int alignment;
816 /* Specific data for a SIMD function clone. */
818 struct GTY(()) cgraph_simd_clone {
819 /* Number of words in the SIMD lane associated with this clone. */
820 unsigned int simdlen;
822 /* Number of annotated function arguments in `args'. This is
823 usually the number of named arguments in FNDECL. */
824 unsigned int nargs;
826 /* Max hardware vector size in bits for integral vectors. */
827 unsigned int vecsize_int;
829 /* Max hardware vector size in bits for floating point vectors. */
830 unsigned int vecsize_float;
832 /* Machine mode of the mask argument(s), if they are to be passed
833 as bitmasks in integer argument(s). VOIDmode if masks are passed
834 as vectors of characteristic type. */
835 machine_mode mask_mode;
837 /* The mangling character for a given vector size. This is used
838 to determine the ISA mangling bit as specified in the Intel
839 Vector ABI. */
840 unsigned char vecsize_mangle;
842 /* True if this is the masked, in-branch version of the clone,
843 otherwise false. */
844 unsigned int inbranch : 1;
846 /* Doubly linked list of SIMD clones. */
847 cgraph_node *prev_clone, *next_clone;
849 /* Original cgraph node the SIMD clones were created for. */
850 cgraph_node *origin;
852 /* Annotated function arguments for the original function. */
853 cgraph_simd_clone_arg GTY((length ("%h.nargs"))) args[1];
856 /* Function Multiversioning info. */
857 struct GTY((for_user)) cgraph_function_version_info {
858 /* The cgraph_node for which the function version info is stored. */
859 cgraph_node *this_node;
860 /* Chains all the semantically identical function versions. The
861 first function in this chain is the version_info node of the
862 default function. */
863 cgraph_function_version_info *prev;
864 /* If this version node corresponds to a dispatcher for function
865 versions, this points to the version info node of the default
866 function, the first node in the chain. */
867 cgraph_function_version_info *next;
868 /* If this node corresponds to a function version, this points
869 to the dispatcher function decl, which is the function that must
870 be called to execute the right function version at run-time.
872 If this cgraph node is a dispatcher (if dispatcher_function is
873 true, in the cgraph_node struct) for function versions, this
874 points to resolver function, which holds the function body of the
875 dispatcher. The dispatcher decl is an alias to the resolver
876 function decl. */
877 tree dispatcher_resolver;
880 #define DEFCIFCODE(code, type, string) CIF_ ## code,
881 /* Reasons for inlining failures. */
883 enum cgraph_inline_failed_t {
884 #include "cif-code.def"
885 CIF_N_REASONS
888 enum cgraph_inline_failed_type_t
890 CIF_FINAL_NORMAL = 0,
891 CIF_FINAL_ERROR
894 struct cgraph_edge;
896 struct cgraph_edge_hasher : ggc_ptr_hash<cgraph_edge>
898 typedef gimple *compare_type;
900 static hashval_t hash (cgraph_edge *);
901 static hashval_t hash (gimple *);
902 static bool equal (cgraph_edge *, gimple *);
905 /* The cgraph data structure.
906 Each function decl has assigned cgraph_node listing callees and callers. */
908 struct GTY((tag ("SYMTAB_FUNCTION"))) cgraph_node : public symtab_node {
909 public:
910 friend class symbol_table;
912 /* Remove the node from cgraph and all inline clones inlined into it.
913 Skip however removal of FORBIDDEN_NODE and return true if it needs to be
914 removed. This allows to call the function from outer loop walking clone
915 tree. */
916 bool remove_symbol_and_inline_clones (cgraph_node *forbidden_node = NULL);
918 /* Record all references from cgraph_node that are taken
919 in statement STMT. */
920 void record_stmt_references (gimple *stmt);
922 /* Like cgraph_set_call_stmt but walk the clone tree and update all
923 clones sharing the same function body.
924 When WHOLE_SPECULATIVE_EDGES is true, all three components of
925 speculative edge gets updated. Otherwise we update only direct
926 call. */
927 void set_call_stmt_including_clones (gimple *old_stmt, gcall *new_stmt,
928 bool update_speculative = true);
930 /* Walk the alias chain to return the function cgraph_node is alias of.
931 Walk through thunk, too.
932 When AVAILABILITY is non-NULL, get minimal availability in the chain.
933 When REF is non-NULL, assume that reference happens in symbol REF
934 when determining the availability. */
935 cgraph_node *function_symbol (enum availability *avail = NULL,
936 struct symtab_node *ref = NULL);
938 /* Walk the alias chain to return the function cgraph_node is alias of.
939 Walk through non virtual thunks, too. Thus we return either a function
940 or a virtual thunk node.
941 When AVAILABILITY is non-NULL, get minimal availability in the chain.
942 When REF is non-NULL, assume that reference happens in symbol REF
943 when determining the availability. */
944 cgraph_node *function_or_virtual_thunk_symbol
945 (enum availability *avail = NULL,
946 struct symtab_node *ref = NULL);
948 /* Create node representing clone of N executed COUNT times. Decrease
949 the execution counts from original node too.
950 The new clone will have decl set to DECL that may or may not be the same
951 as decl of N.
953 When UPDATE_ORIGINAL is true, the counts are subtracted from the original
954 function's profile to reflect the fact that part of execution is handled
955 by node.
956 When CALL_DUPLICATOIN_HOOK is true, the ipa passes are acknowledged about
957 the new clone. Otherwise the caller is responsible for doing so later.
959 If the new node is being inlined into another one, NEW_INLINED_TO should be
960 the outline function the new one is (even indirectly) inlined to.
961 All hooks will see this in node's global.inlined_to, when invoked.
962 Can be NULL if the node is not inlined. SUFFIX is string that is appended
963 to the original name. */
964 cgraph_node *create_clone (tree decl, profile_count count,
965 bool update_original,
966 vec<cgraph_edge *> redirect_callers,
967 bool call_duplication_hook,
968 cgraph_node *new_inlined_to,
969 bitmap args_to_skip, const char *suffix = NULL);
971 /* Create callgraph node clone with new declaration. The actual body will be
972 copied later at compilation stage. The name of the new clone will be
973 constructed from the name of the original node, SUFFIX and NUM_SUFFIX. */
974 cgraph_node *create_virtual_clone (vec<cgraph_edge *> redirect_callers,
975 vec<ipa_replace_map *, va_gc> *tree_map,
976 bitmap args_to_skip, const char * suffix,
977 unsigned num_suffix);
979 /* cgraph node being removed from symbol table; see if its entry can be
980 replaced by other inline clone. */
981 cgraph_node *find_replacement (void);
983 /* Create a new cgraph node which is the new version of
984 callgraph node. REDIRECT_CALLERS holds the callers
985 edges which should be redirected to point to
986 NEW_VERSION. ALL the callees edges of the node
987 are cloned to the new version node. Return the new
988 version node.
990 If non-NULL BLOCK_TO_COPY determine what basic blocks
991 was copied to prevent duplications of calls that are dead
992 in the clone.
994 SUFFIX is string that is appended to the original name. */
996 cgraph_node *create_version_clone (tree new_decl,
997 vec<cgraph_edge *> redirect_callers,
998 bitmap bbs_to_copy,
999 const char *suffix = NULL);
1001 /* Perform function versioning.
1002 Function versioning includes copying of the tree and
1003 a callgraph update (creating a new cgraph node and updating
1004 its callees and callers).
1006 REDIRECT_CALLERS varray includes the edges to be redirected
1007 to the new version.
1009 TREE_MAP is a mapping of tree nodes we want to replace with
1010 new ones (according to results of prior analysis).
1012 If non-NULL ARGS_TO_SKIP determine function parameters to remove
1013 from new version.
1014 If SKIP_RETURN is true, the new version will return void.
1015 If non-NULL BLOCK_TO_COPY determine what basic blocks to copy.
1016 If non_NULL NEW_ENTRY determine new entry BB of the clone.
1018 Return the new version's cgraph node. */
1019 cgraph_node *create_version_clone_with_body
1020 (vec<cgraph_edge *> redirect_callers,
1021 vec<ipa_replace_map *, va_gc> *tree_map, bitmap args_to_skip,
1022 bool skip_return, bitmap bbs_to_copy, basic_block new_entry_block,
1023 const char *clone_name);
1025 /* Insert a new cgraph_function_version_info node into cgraph_fnver_htab
1026 corresponding to cgraph_node. */
1027 cgraph_function_version_info *insert_new_function_version (void);
1029 /* Get the cgraph_function_version_info node corresponding to node. */
1030 cgraph_function_version_info *function_version (void);
1032 /* Discover all functions and variables that are trivially needed, analyze
1033 them as well as all functions and variables referred by them */
1034 void analyze (void);
1036 /* Add thunk alias into callgraph. The alias declaration is ALIAS and it
1037 aliases DECL with an adjustments made into the first parameter.
1038 See comments in struct cgraph_thunk_info for detail on the parameters. */
1039 cgraph_node * create_thunk (tree alias, tree, bool this_adjusting,
1040 HOST_WIDE_INT fixed_offset,
1041 HOST_WIDE_INT virtual_value,
1042 HOST_WIDE_INT indirect_offset,
1043 tree virtual_offset,
1044 tree real_alias);
1047 /* Return node that alias is aliasing. */
1048 inline cgraph_node *get_alias_target (void);
1050 /* Given function symbol, walk the alias chain to return the function node
1051 is alias of. Do not walk through thunks.
1052 When AVAILABILITY is non-NULL, get minimal availability in the chain.
1053 When REF is non-NULL, assume that reference happens in symbol REF
1054 when determining the availability. */
1056 cgraph_node *ultimate_alias_target (availability *availability = NULL,
1057 symtab_node *ref = NULL);
1059 /* Expand thunk NODE to gimple if possible.
1060 When FORCE_GIMPLE_THUNK is true, gimple thunk is created and
1061 no assembler is produced.
1062 When OUTPUT_ASM_THUNK is true, also produce assembler for
1063 thunks that are not lowered. */
1064 bool expand_thunk (bool output_asm_thunks, bool force_gimple_thunk);
1066 /* Call expand_thunk on all callers that are thunks and analyze those
1067 nodes that were expanded. */
1068 void expand_all_artificial_thunks ();
1070 /* Assemble thunks and aliases associated to node. */
1071 void assemble_thunks_and_aliases (void);
1073 /* Expand function specified by node. */
1074 void expand (void);
1076 /* As an GCC extension we allow redefinition of the function. The
1077 semantics when both copies of bodies differ is not well defined.
1078 We replace the old body with new body so in unit at a time mode
1079 we always use new body, while in normal mode we may end up with
1080 old body inlined into some functions and new body expanded and
1081 inlined in others. */
1082 void reset (void);
1084 /* Creates a wrapper from cgraph_node to TARGET node. Thunk is used for this
1085 kind of wrapper method. */
1086 void create_wrapper (cgraph_node *target);
1088 /* Verify cgraph nodes of the cgraph node. */
1089 void DEBUG_FUNCTION verify_node (void);
1091 /* Remove function from symbol table. */
1092 void remove (void);
1094 /* Dump call graph node to file F. */
1095 void dump (FILE *f);
1097 /* Dump call graph node to stderr. */
1098 void DEBUG_FUNCTION debug (void);
1100 /* When doing LTO, read cgraph_node's body from disk if it is not already
1101 present. */
1102 bool get_untransformed_body (void);
1104 /* Prepare function body. When doing LTO, read cgraph_node's body from disk
1105 if it is not already present. When some IPA transformations are scheduled,
1106 apply them. */
1107 bool get_body (void);
1109 /* Release memory used to represent body of function.
1110 Use this only for functions that are released before being translated to
1111 target code (i.e. RTL). Functions that are compiled to RTL and beyond
1112 are free'd in final.c via free_after_compilation(). */
1113 void release_body (bool keep_arguments = false);
1115 /* Return the DECL_STRUCT_FUNCTION of the function. */
1116 struct function *get_fun (void);
1118 /* cgraph_node is no longer nested function; update cgraph accordingly. */
1119 void unnest (void);
1121 /* Bring cgraph node local. */
1122 void make_local (void);
1124 /* Likewise indicate that a node is having address taken. */
1125 void mark_address_taken (void);
1127 /* Set fialization priority to PRIORITY. */
1128 void set_fini_priority (priority_type priority);
1130 /* Return the finalization priority. */
1131 priority_type get_fini_priority (void);
1133 /* Create edge from a given function to CALLEE in the cgraph. */
1134 cgraph_edge *create_edge (cgraph_node *callee,
1135 gcall *call_stmt, profile_count count);
1137 /* Create an indirect edge with a yet-undetermined callee where the call
1138 statement destination is a formal parameter of the caller with index
1139 PARAM_INDEX. */
1140 cgraph_edge *create_indirect_edge (gcall *call_stmt, int ecf_flags,
1141 profile_count count,
1142 bool compute_indirect_info = true);
1144 /* Like cgraph_create_edge walk the clone tree and update all clones sharing
1145 same function body. If clones already have edge for OLD_STMT; only
1146 update the edge same way as cgraph_set_call_stmt_including_clones does. */
1147 void create_edge_including_clones (cgraph_node *callee,
1148 gimple *old_stmt, gcall *stmt,
1149 profile_count count,
1150 cgraph_inline_failed_t reason);
1152 /* Return the callgraph edge representing the GIMPLE_CALL statement
1153 CALL_STMT. */
1154 cgraph_edge *get_edge (gimple *call_stmt);
1156 /* Collect all callers of cgraph_node and its aliases that are known to lead
1157 to NODE (i.e. are not overwritable) and that are not thunks. */
1158 vec<cgraph_edge *> collect_callers (void);
1160 /* Remove all callers from the node. */
1161 void remove_callers (void);
1163 /* Remove all callees from the node. */
1164 void remove_callees (void);
1166 /* Return function availability. See cgraph.h for description of individual
1167 return values. */
1168 enum availability get_availability (symtab_node *ref = NULL);
1170 /* Set TREE_NOTHROW on cgraph_node's decl and on aliases of the node
1171 if any to NOTHROW. */
1172 bool set_nothrow_flag (bool nothrow);
1174 /* SET DECL_IS_MALLOC on cgraph_node's decl and on aliases of the node
1175 if any. */
1176 bool set_malloc_flag (bool malloc_p);
1178 /* If SET_CONST is true, mark function, aliases and thunks to be ECF_CONST.
1179 If SET_CONST if false, clear the flag.
1181 When setting the flag be careful about possible interposition and
1182 do not set the flag for functions that can be interposet and set pure
1183 flag for functions that can bind to other definition.
1185 Return true if any change was done. */
1187 bool set_const_flag (bool set_const, bool looping);
1189 /* Set DECL_PURE_P on cgraph_node's decl and on aliases of the node
1190 if any to PURE.
1192 When setting the flag, be careful about possible interposition.
1193 Return true if any change was done. */
1195 bool set_pure_flag (bool pure, bool looping);
1197 /* Call callback on function and aliases associated to the function.
1198 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1199 skipped. */
1201 bool call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
1202 void *),
1203 void *data, bool include_overwritable);
1205 /* Call callback on cgraph_node, thunks and aliases associated to NODE.
1206 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1207 skipped. When EXCLUDE_VIRTUAL_THUNKS is true, virtual thunks are
1208 skipped. */
1209 bool call_for_symbol_thunks_and_aliases (bool (*callback) (cgraph_node *node,
1210 void *data),
1211 void *data,
1212 bool include_overwritable,
1213 bool exclude_virtual_thunks = false);
1215 /* Likewise indicate that a node is needed, i.e. reachable via some
1216 external means. */
1217 inline void mark_force_output (void);
1219 /* Return true when function can be marked local. */
1220 bool local_p (void);
1222 /* Return true if cgraph_node can be made local for API change.
1223 Extern inline functions and C++ COMDAT functions can be made local
1224 at the expense of possible code size growth if function is used in multiple
1225 compilation units. */
1226 bool can_be_local_p (void);
1228 /* Return true when cgraph_node can not return or throw and thus
1229 it is safe to ignore its side effects for IPA analysis. */
1230 bool cannot_return_p (void);
1232 /* Return true when function cgraph_node and all its aliases are only called
1233 directly.
1234 i.e. it is not externally visible, address was not taken and
1235 it is not used in any other non-standard way. */
1236 bool only_called_directly_p (void);
1238 /* Return true when function is only called directly or it has alias.
1239 i.e. it is not externally visible, address was not taken and
1240 it is not used in any other non-standard way. */
1241 inline bool only_called_directly_or_aliased_p (void);
1243 /* Return true when function cgraph_node can be expected to be removed
1244 from program when direct calls in this compilation unit are removed.
1246 As a special case COMDAT functions are
1247 cgraph_can_remove_if_no_direct_calls_p while the are not
1248 cgraph_only_called_directly_p (it is possible they are called from other
1249 unit)
1251 This function behaves as cgraph_only_called_directly_p because eliminating
1252 all uses of COMDAT function does not make it necessarily disappear from
1253 the program unless we are compiling whole program or we do LTO. In this
1254 case we know we win since dynamic linking will not really discard the
1255 linkonce section.
1257 If WILL_INLINE is true, assume that function will be inlined into all the
1258 direct calls. */
1259 bool will_be_removed_from_program_if_no_direct_calls_p
1260 (bool will_inline = false);
1262 /* Return true when function can be removed from callgraph
1263 if all direct calls and references are eliminated. The function does
1264 not take into account comdat groups. */
1265 bool can_remove_if_no_direct_calls_and_refs_p (void);
1267 /* Return true when function cgraph_node and its aliases can be removed from
1268 callgraph if all direct calls are eliminated.
1269 If WILL_INLINE is true, assume that function will be inlined into all the
1270 direct calls. */
1271 bool can_remove_if_no_direct_calls_p (bool will_inline = false);
1273 /* Return true when callgraph node is a function with Gimple body defined
1274 in current unit. Functions can also be define externally or they
1275 can be thunks with no Gimple representation.
1277 Note that at WPA stage, the function body may not be present in memory. */
1278 inline bool has_gimple_body_p (void);
1280 /* Return true if function should be optimized for size. */
1281 bool optimize_for_size_p (void);
1283 /* Dump the callgraph to file F. */
1284 static void dump_cgraph (FILE *f);
1286 /* Dump the call graph to stderr. */
1287 static inline
1288 void debug_cgraph (void)
1290 dump_cgraph (stderr);
1293 /* Get unique identifier of the node. */
1294 inline int get_uid ()
1296 return m_uid;
1299 /* Record that DECL1 and DECL2 are semantically identical function
1300 versions. */
1301 static void record_function_versions (tree decl1, tree decl2);
1303 /* Remove the cgraph_function_version_info and cgraph_node for DECL. This
1304 DECL is a duplicate declaration. */
1305 static void delete_function_version_by_decl (tree decl);
1307 /* Add the function FNDECL to the call graph.
1308 Unlike finalize_function, this function is intended to be used
1309 by middle end and allows insertion of new function at arbitrary point
1310 of compilation. The function can be either in high, low or SSA form
1311 GIMPLE.
1313 The function is assumed to be reachable and have address taken (so no
1314 API breaking optimizations are performed on it).
1316 Main work done by this function is to enqueue the function for later
1317 processing to avoid need the passes to be re-entrant. */
1318 static void add_new_function (tree fndecl, bool lowered);
1320 /* Return callgraph node for given symbol and check it is a function. */
1321 static inline cgraph_node *get (const_tree decl)
1323 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL);
1324 return dyn_cast <cgraph_node *> (symtab_node::get (decl));
1327 /* DECL has been parsed. Take it, queue it, compile it at the whim of the
1328 logic in effect. If NO_COLLECT is true, then our caller cannot stand to
1329 have the garbage collector run at the moment. We would need to either
1330 create a new GC context, or just not compile right now. */
1331 static void finalize_function (tree, bool);
1333 /* Return cgraph node assigned to DECL. Create new one when needed. */
1334 static cgraph_node * create (tree decl);
1336 /* Try to find a call graph node for declaration DECL and if it does not
1337 exist or if it corresponds to an inline clone, create a new one. */
1338 static cgraph_node * get_create (tree);
1340 /* Return local info for the compiled function. */
1341 static cgraph_local_info *local_info (tree decl);
1343 /* Return local info for the compiled function. */
1344 static struct cgraph_rtl_info *rtl_info (tree);
1346 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
1347 Return NULL if there's no such node. */
1348 static cgraph_node *get_for_asmname (tree asmname);
1350 /* Attempt to mark ALIAS as an alias to DECL. Return alias node if
1351 successful and NULL otherwise.
1352 Same body aliases are output whenever the body of DECL is output,
1353 and cgraph_node::get (ALIAS) transparently
1354 returns cgraph_node::get (DECL). */
1355 static cgraph_node * create_same_body_alias (tree alias, tree decl);
1357 /* Verify whole cgraph structure. */
1358 static void DEBUG_FUNCTION verify_cgraph_nodes (void);
1360 /* Verify cgraph, if consistency checking is enabled. */
1361 static inline void checking_verify_cgraph_nodes (void);
1363 /* Worker to bring NODE local. */
1364 static bool make_local (cgraph_node *node, void *);
1366 /* Mark ALIAS as an alias to DECL. DECL_NODE is cgraph node representing
1367 the function body is associated
1368 with (not necessarily cgraph_node (DECL). */
1369 static cgraph_node *create_alias (tree alias, tree target);
1371 /* Return true if NODE has thunk. */
1372 static bool has_thunk_p (cgraph_node *node, void *);
1374 cgraph_edge *callees;
1375 cgraph_edge *callers;
1376 /* List of edges representing indirect calls with a yet undetermined
1377 callee. */
1378 cgraph_edge *indirect_calls;
1379 /* For nested functions points to function the node is nested in. */
1380 cgraph_node *origin;
1381 /* Points to first nested function, if any. */
1382 cgraph_node *nested;
1383 /* Pointer to the next function with same origin, if any. */
1384 cgraph_node *next_nested;
1385 /* Pointer to the next clone. */
1386 cgraph_node *next_sibling_clone;
1387 cgraph_node *prev_sibling_clone;
1388 cgraph_node *clones;
1389 cgraph_node *clone_of;
1390 /* For functions with many calls sites it holds map from call expression
1391 to the edge to speed up cgraph_edge function. */
1392 hash_table<cgraph_edge_hasher> *GTY(()) call_site_hash;
1393 /* Declaration node used to be clone of. */
1394 tree former_clone_of;
1396 /* If this is a SIMD clone, this points to the SIMD specific
1397 information for it. */
1398 cgraph_simd_clone *simdclone;
1399 /* If this function has SIMD clones, this points to the first clone. */
1400 cgraph_node *simd_clones;
1402 /* Interprocedural passes scheduled to have their transform functions
1403 applied next time we execute local pass on them. We maintain it
1404 per-function in order to allow IPA passes to introduce new functions. */
1405 vec<ipa_opt_pass> GTY((skip)) ipa_transforms_to_apply;
1407 cgraph_local_info local;
1408 cgraph_global_info global;
1409 struct cgraph_rtl_info *rtl;
1410 cgraph_clone_info clone;
1411 cgraph_thunk_info thunk;
1413 /* Expected number of executions: calculated in profile.c. */
1414 profile_count count;
1415 /* How to scale counts at materialization time; used to merge
1416 LTO units with different number of profile runs. */
1417 int count_materialization_scale;
1418 /* ID assigned by the profiling. */
1419 unsigned int profile_id;
1420 /* Time profiler: first run of function. */
1421 int tp_first_run;
1423 /* Set when decl is an abstract function pointed to by the
1424 ABSTRACT_DECL_ORIGIN of a reachable function. */
1425 unsigned used_as_abstract_origin : 1;
1426 /* Set once the function is lowered (i.e. its CFG is built). */
1427 unsigned lowered : 1;
1428 /* Set once the function has been instantiated and its callee
1429 lists created. */
1430 unsigned process : 1;
1431 /* How commonly executed the node is. Initialized during branch
1432 probabilities pass. */
1433 ENUM_BITFIELD (node_frequency) frequency : 2;
1434 /* True when function can only be called at startup (from static ctor). */
1435 unsigned only_called_at_startup : 1;
1436 /* True when function can only be called at startup (from static dtor). */
1437 unsigned only_called_at_exit : 1;
1438 /* True when function is the transactional clone of a function which
1439 is called only from inside transactions. */
1440 /* ?? We should be able to remove this. We have enough bits in
1441 cgraph to calculate it. */
1442 unsigned tm_clone : 1;
1443 /* True if this decl is a dispatcher for function versions. */
1444 unsigned dispatcher_function : 1;
1445 /* True if this decl calls a COMDAT-local function. This is set up in
1446 compute_fn_summary and inline_call. */
1447 unsigned calls_comdat_local : 1;
1448 /* True if node has been created by merge operation in IPA-ICF. */
1449 unsigned icf_merged: 1;
1450 /* True if call to node can't result in a call to free, munmap or
1451 other operation that could make previously non-trapping memory
1452 accesses trapping. */
1453 unsigned nonfreeing_fn : 1;
1454 /* True if there was multiple COMDAT bodies merged by lto-symtab. */
1455 unsigned merged_comdat : 1;
1456 /* True if function was created to be executed in parallel. */
1457 unsigned parallelized_function : 1;
1458 /* True if function is part split out by ipa-split. */
1459 unsigned split_part : 1;
1460 /* True if the function appears as possible target of indirect call. */
1461 unsigned indirect_call_target : 1;
1463 private:
1464 /* Unique id of the node. */
1465 int m_uid;
1467 /* Worker for call_for_symbol_and_aliases. */
1468 bool call_for_symbol_and_aliases_1 (bool (*callback) (cgraph_node *,
1469 void *),
1470 void *data, bool include_overwritable);
1473 /* A cgraph node set is a collection of cgraph nodes. A cgraph node
1474 can appear in multiple sets. */
1475 struct cgraph_node_set_def
1477 hash_map<cgraph_node *, size_t> *map;
1478 vec<cgraph_node *> nodes;
1481 typedef cgraph_node_set_def *cgraph_node_set;
1482 typedef struct varpool_node_set_def *varpool_node_set;
1484 class varpool_node;
1486 /* A varpool node set is a collection of varpool nodes. A varpool node
1487 can appear in multiple sets. */
1488 struct varpool_node_set_def
1490 hash_map<varpool_node *, size_t> * map;
1491 vec<varpool_node *> nodes;
1494 /* Iterator structure for cgraph node sets. */
1495 struct cgraph_node_set_iterator
1497 cgraph_node_set set;
1498 unsigned index;
1501 /* Iterator structure for varpool node sets. */
1502 struct varpool_node_set_iterator
1504 varpool_node_set set;
1505 unsigned index;
1508 /* Context of polymorphic call. It represent information about the type of
1509 instance that may reach the call. This is used by ipa-devirt walkers of the
1510 type inheritance graph. */
1512 class GTY(()) ipa_polymorphic_call_context {
1513 public:
1514 /* The called object appears in an object of type OUTER_TYPE
1515 at offset OFFSET. When information is not 100% reliable, we
1516 use SPECULATIVE_OUTER_TYPE and SPECULATIVE_OFFSET. */
1517 HOST_WIDE_INT offset;
1518 HOST_WIDE_INT speculative_offset;
1519 tree outer_type;
1520 tree speculative_outer_type;
1521 /* True if outer object may be in construction or destruction. */
1522 unsigned maybe_in_construction : 1;
1523 /* True if outer object may be of derived type. */
1524 unsigned maybe_derived_type : 1;
1525 /* True if speculative outer object may be of derived type. We always
1526 speculate that construction does not happen. */
1527 unsigned speculative_maybe_derived_type : 1;
1528 /* True if the context is invalid and all calls should be redirected
1529 to BUILTIN_UNREACHABLE. */
1530 unsigned invalid : 1;
1531 /* True if the outer type is dynamic. */
1532 unsigned dynamic : 1;
1534 /* Build empty "I know nothing" context. */
1535 ipa_polymorphic_call_context ();
1536 /* Build polymorphic call context for indirect call E. */
1537 ipa_polymorphic_call_context (cgraph_edge *e);
1538 /* Build polymorphic call context for IP invariant CST.
1539 If specified, OTR_TYPE specify the type of polymorphic call
1540 that takes CST+OFFSET as a prameter. */
1541 ipa_polymorphic_call_context (tree cst, tree otr_type = NULL,
1542 HOST_WIDE_INT offset = 0);
1543 /* Build context for pointer REF contained in FNDECL at statement STMT.
1544 if INSTANCE is non-NULL, return pointer to the object described by
1545 the context. */
1546 ipa_polymorphic_call_context (tree fndecl, tree ref, gimple *stmt,
1547 tree *instance = NULL);
1549 /* Look for vtable stores or constructor calls to work out dynamic type
1550 of memory location. */
1551 bool get_dynamic_type (tree, tree, tree, gimple *);
1553 /* Make context non-speculative. */
1554 void clear_speculation ();
1556 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
1557 NULL, the context is set to dummy "I know nothing" setting. */
1558 void clear_outer_type (tree otr_type = NULL);
1560 /* Walk container types and modify context to point to actual class
1561 containing OTR_TYPE (if non-NULL) as base class.
1562 Return true if resulting context is valid.
1564 When CONSIDER_PLACEMENT_NEW is false, reject contexts that may be made
1565 valid only via allocation of new polymorphic type inside by means
1566 of placement new.
1568 When CONSIDER_BASES is false, only look for actual fields, not base types
1569 of TYPE. */
1570 bool restrict_to_inner_class (tree otr_type,
1571 bool consider_placement_new = true,
1572 bool consider_bases = true);
1574 /* Adjust all offsets in contexts by given number of bits. */
1575 void offset_by (HOST_WIDE_INT);
1576 /* Use when we can not track dynamic type change. This speculatively assume
1577 type change is not happening. */
1578 void possible_dynamic_type_change (bool, tree otr_type = NULL);
1579 /* Assume that both THIS and a given context is valid and strenghten THIS
1580 if possible. Return true if any strenghtening was made.
1581 If actual type the context is being used in is known, OTR_TYPE should be
1582 set accordingly. This improves quality of combined result. */
1583 bool combine_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1584 bool meet_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1586 /* Return TRUE if context is fully useless. */
1587 bool useless_p () const;
1588 /* Return TRUE if this context conveys the same information as X. */
1589 bool equal_to (const ipa_polymorphic_call_context &x) const;
1591 /* Dump human readable context to F. If NEWLINE is true, it will be
1592 terminated by a newline. */
1593 void dump (FILE *f, bool newline = true) const;
1594 void DEBUG_FUNCTION debug () const;
1596 /* LTO streaming. */
1597 void stream_out (struct output_block *) const;
1598 void stream_in (struct lto_input_block *, struct data_in *data_in);
1600 private:
1601 bool combine_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1602 bool meet_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1603 void set_by_decl (tree, HOST_WIDE_INT);
1604 bool set_by_invariant (tree, tree, HOST_WIDE_INT);
1605 bool speculation_consistent_p (tree, HOST_WIDE_INT, bool, tree) const;
1606 void make_speculative (tree otr_type = NULL);
1609 /* Structure containing additional information about an indirect call. */
1611 struct GTY(()) cgraph_indirect_call_info
1613 /* When agg_content is set, an offset where the call pointer is located
1614 within the aggregate. */
1615 HOST_WIDE_INT offset;
1616 /* Context of the polymorphic call; use only when POLYMORPHIC flag is set. */
1617 ipa_polymorphic_call_context context;
1618 /* OBJ_TYPE_REF_TOKEN of a polymorphic call (if polymorphic is set). */
1619 HOST_WIDE_INT otr_token;
1620 /* Type of the object from OBJ_TYPE_REF_OBJECT. */
1621 tree otr_type;
1622 /* Index of the parameter that is called. */
1623 int param_index;
1624 /* ECF flags determined from the caller. */
1625 int ecf_flags;
1626 /* Profile_id of common target obtrained from profile. */
1627 int common_target_id;
1628 /* Probability that call will land in function with COMMON_TARGET_ID. */
1629 int common_target_probability;
1631 /* Set when the call is a virtual call with the parameter being the
1632 associated object pointer rather than a simple direct call. */
1633 unsigned polymorphic : 1;
1634 /* Set when the call is a call of a pointer loaded from contents of an
1635 aggregate at offset. */
1636 unsigned agg_contents : 1;
1637 /* Set when this is a call through a member pointer. */
1638 unsigned member_ptr : 1;
1639 /* When the agg_contents bit is set, this one determines whether the
1640 destination is loaded from a parameter passed by reference. */
1641 unsigned by_ref : 1;
1642 /* When the agg_contents bit is set, this one determines whether we can
1643 deduce from the function body that the loaded value from the reference is
1644 never modified between the invocation of the function and the load
1645 point. */
1646 unsigned guaranteed_unmodified : 1;
1647 /* For polymorphic calls this specify whether the virtual table pointer
1648 may have changed in between function entry and the call. */
1649 unsigned vptr_changed : 1;
1652 struct GTY((chain_next ("%h.next_caller"), chain_prev ("%h.prev_caller"),
1653 for_user)) cgraph_edge {
1654 friend class cgraph_node;
1655 friend class symbol_table;
1657 /* Remove the edge in the cgraph. */
1658 void remove (void);
1660 /* Change field call_stmt of edge to NEW_STMT.
1661 If UPDATE_SPECULATIVE and E is any component of speculative
1662 edge, then update all components. */
1663 void set_call_stmt (gcall *new_stmt, bool update_speculative = true);
1665 /* Redirect callee of the edge to N. The function does not update underlying
1666 call expression. */
1667 void redirect_callee (cgraph_node *n);
1669 /* If the edge does not lead to a thunk, simply redirect it to N. Otherwise
1670 create one or more equivalent thunks for N and redirect E to the first in
1671 the chain. Note that it is then necessary to call
1672 n->expand_all_artificial_thunks once all callers are redirected. */
1673 void redirect_callee_duplicating_thunks (cgraph_node *n);
1675 /* Make an indirect edge with an unknown callee an ordinary edge leading to
1676 CALLEE. DELTA is an integer constant that is to be added to the this
1677 pointer (first parameter) to compensate for skipping
1678 a thunk adjustment. */
1679 cgraph_edge *make_direct (cgraph_node *callee);
1681 /* Turn edge into speculative call calling N2. Update
1682 the profile so the direct call is taken COUNT times
1683 with FREQUENCY. */
1684 cgraph_edge *make_speculative (cgraph_node *n2, profile_count direct_count);
1686 /* Given speculative call edge, return all three components. */
1687 void speculative_call_info (cgraph_edge *&direct, cgraph_edge *&indirect,
1688 ipa_ref *&reference);
1690 /* Speculative call edge turned out to be direct call to CALLE_DECL.
1691 Remove the speculative call sequence and return edge representing the call.
1692 It is up to caller to redirect the call as appropriate. */
1693 cgraph_edge *resolve_speculation (tree callee_decl = NULL);
1695 /* If necessary, change the function declaration in the call statement
1696 associated with the edge so that it corresponds to the edge callee. */
1697 gimple *redirect_call_stmt_to_callee (void);
1699 /* Create clone of edge in the node N represented
1700 by CALL_EXPR the callgraph. */
1701 cgraph_edge * clone (cgraph_node *n, gcall *call_stmt, unsigned stmt_uid,
1702 profile_count num, profile_count den,
1703 bool update_original);
1705 /* Verify edge count and frequency. */
1706 bool verify_count ();
1708 /* Return true when call of edge can not lead to return from caller
1709 and thus it is safe to ignore its side effects for IPA analysis
1710 when computing side effects of the caller. */
1711 bool cannot_lead_to_return_p (void);
1713 /* Return true when the edge represents a direct recursion. */
1714 bool recursive_p (void);
1716 /* Return true if the call can be hot. */
1717 bool maybe_hot_p (void);
1719 /* Get unique identifier of the edge. */
1720 inline int get_uid ()
1722 return m_uid;
1725 /* Rebuild cgraph edges for current function node. This needs to be run after
1726 passes that don't update the cgraph. */
1727 static unsigned int rebuild_edges (void);
1729 /* Rebuild cgraph references for current function node. This needs to be run
1730 after passes that don't update the cgraph. */
1731 static void rebuild_references (void);
1733 /* Expected number of executions: calculated in profile.c. */
1734 profile_count count;
1735 cgraph_node *caller;
1736 cgraph_node *callee;
1737 cgraph_edge *prev_caller;
1738 cgraph_edge *next_caller;
1739 cgraph_edge *prev_callee;
1740 cgraph_edge *next_callee;
1741 gcall *call_stmt;
1742 /* Additional information about an indirect call. Not cleared when an edge
1743 becomes direct. */
1744 cgraph_indirect_call_info *indirect_info;
1745 PTR GTY ((skip (""))) aux;
1746 /* When equal to CIF_OK, inline this call. Otherwise, points to the
1747 explanation why function was not inlined. */
1748 enum cgraph_inline_failed_t inline_failed;
1749 /* The stmt_uid of call_stmt. This is used by LTO to recover the call_stmt
1750 when the function is serialized in. */
1751 unsigned int lto_stmt_uid;
1752 /* Whether this edge was made direct by indirect inlining. */
1753 unsigned int indirect_inlining_edge : 1;
1754 /* Whether this edge describes an indirect call with an undetermined
1755 callee. */
1756 unsigned int indirect_unknown_callee : 1;
1757 /* Whether this edge is still a dangling */
1758 /* True if the corresponding CALL stmt cannot be inlined. */
1759 unsigned int call_stmt_cannot_inline_p : 1;
1760 /* Can this call throw externally? */
1761 unsigned int can_throw_external : 1;
1762 /* Edges with SPECULATIVE flag represents indirect calls that was
1763 speculatively turned into direct (i.e. by profile feedback).
1764 The final code sequence will have form:
1766 if (call_target == expected_fn)
1767 expected_fn ();
1768 else
1769 call_target ();
1771 Every speculative call is represented by three components attached
1772 to a same call statement:
1773 1) a direct call (to expected_fn)
1774 2) an indirect call (to call_target)
1775 3) a IPA_REF_ADDR refrence to expected_fn.
1777 Optimizers may later redirect direct call to clone, so 1) and 3)
1778 do not need to necesarily agree with destination. */
1779 unsigned int speculative : 1;
1780 /* Set to true when caller is a constructor or destructor of polymorphic
1781 type. */
1782 unsigned in_polymorphic_cdtor : 1;
1784 /* Return true if call must bind to current definition. */
1785 bool binds_to_current_def_p ();
1787 /* Expected frequency of executions within the function.
1788 When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
1789 per function call. The range is 0 to CGRAPH_FREQ_MAX. */
1790 int frequency ();
1792 /* Expected frequency of executions within the function. */
1793 sreal sreal_frequency ();
1794 private:
1795 /* Unique id of the edge. */
1796 int m_uid;
1798 /* Remove the edge from the list of the callers of the callee. */
1799 void remove_caller (void);
1801 /* Remove the edge from the list of the callees of the caller. */
1802 void remove_callee (void);
1804 /* Set callee N of call graph edge and add it to the corresponding set of
1805 callers. */
1806 void set_callee (cgraph_node *n);
1808 /* Output flags of edge to a file F. */
1809 void dump_edge_flags (FILE *f);
1811 /* Verify that call graph edge corresponds to DECL from the associated
1812 statement. Return true if the verification should fail. */
1813 bool verify_corresponds_to_fndecl (tree decl);
1816 #define CGRAPH_FREQ_BASE 1000
1817 #define CGRAPH_FREQ_MAX 100000
1819 /* The varpool data structure.
1820 Each static variable decl has assigned varpool_node. */
1822 class GTY((tag ("SYMTAB_VARIABLE"))) varpool_node : public symtab_node {
1823 public:
1824 /* Dump given varpool node to F. */
1825 void dump (FILE *f);
1827 /* Dump given varpool node to stderr. */
1828 void DEBUG_FUNCTION debug (void);
1830 /* Remove variable from symbol table. */
1831 void remove (void);
1833 /* Remove node initializer when it is no longer needed. */
1834 void remove_initializer (void);
1836 void analyze (void);
1838 /* Return variable availability. */
1839 availability get_availability (symtab_node *ref = NULL);
1841 /* When doing LTO, read variable's constructor from disk if
1842 it is not already present. */
1843 tree get_constructor (void);
1845 /* Return true if variable has constructor that can be used for folding. */
1846 bool ctor_useable_for_folding_p (void);
1848 /* For given variable pool node, walk the alias chain to return the function
1849 the variable is alias of. Do not walk through thunks.
1850 When AVAILABILITY is non-NULL, get minimal availability in the chain.
1851 When REF is non-NULL, assume that reference happens in symbol REF
1852 when determining the availability. */
1853 inline varpool_node *ultimate_alias_target
1854 (availability *availability = NULL, symtab_node *ref = NULL);
1856 /* Return node that alias is aliasing. */
1857 inline varpool_node *get_alias_target (void);
1859 /* Output one variable, if necessary. Return whether we output it. */
1860 bool assemble_decl (void);
1862 /* For variables in named sections make sure get_variable_section
1863 is called before we switch to those sections. Then section
1864 conflicts between read-only and read-only requiring relocations
1865 sections can be resolved. */
1866 void finalize_named_section_flags (void);
1868 /* Call calback on varpool symbol and aliases associated to varpool symbol.
1869 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1870 skipped. */
1871 bool call_for_symbol_and_aliases (bool (*callback) (varpool_node *, void *),
1872 void *data,
1873 bool include_overwritable);
1875 /* Return true when variable should be considered externally visible. */
1876 bool externally_visible_p (void);
1878 /* Return true when all references to variable must be visible
1879 in ipa_ref_list.
1880 i.e. if the variable is not externally visible or not used in some magic
1881 way (asm statement or such).
1882 The magic uses are all summarized in force_output flag. */
1883 inline bool all_refs_explicit_p ();
1885 /* Return true when variable can be removed from variable pool
1886 if all direct calls are eliminated. */
1887 inline bool can_remove_if_no_refs_p (void);
1889 /* Add the variable DECL to the varpool.
1890 Unlike finalize_decl function is intended to be used
1891 by middle end and allows insertion of new variable at arbitrary point
1892 of compilation. */
1893 static void add (tree decl);
1895 /* Return varpool node for given symbol and check it is a function. */
1896 static inline varpool_node *get (const_tree decl);
1898 /* Mark DECL as finalized. By finalizing the declaration, frontend instruct
1899 the middle end to output the variable to asm file, if needed or externally
1900 visible. */
1901 static void finalize_decl (tree decl);
1903 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1904 Extra name aliases are output whenever DECL is output. */
1905 static varpool_node * create_extra_name_alias (tree alias, tree decl);
1907 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1908 Extra name aliases are output whenever DECL is output. */
1909 static varpool_node * create_alias (tree, tree);
1911 /* Dump the variable pool to F. */
1912 static void dump_varpool (FILE *f);
1914 /* Dump the variable pool to stderr. */
1915 static void DEBUG_FUNCTION debug_varpool (void);
1917 /* Allocate new callgraph node and insert it into basic data structures. */
1918 static varpool_node *create_empty (void);
1920 /* Return varpool node assigned to DECL. Create new one when needed. */
1921 static varpool_node *get_create (tree decl);
1923 /* Given an assembler name, lookup node. */
1924 static varpool_node *get_for_asmname (tree asmname);
1926 /* Set when variable is scheduled to be assembled. */
1927 unsigned output : 1;
1929 /* Set when variable has statically initialized pointer
1930 or is a static bounds variable and needs initalization. */
1931 unsigned need_bounds_init : 1;
1933 /* Set if the variable is dynamically initialized, except for
1934 function local statics. */
1935 unsigned dynamically_initialized : 1;
1937 ENUM_BITFIELD(tls_model) tls_model : 3;
1939 /* Set if the variable is known to be used by single function only.
1940 This is computed by ipa_signle_use pass and used by late optimizations
1941 in places where optimization would be valid for local static variable
1942 if we did not do any inter-procedural code movement. */
1943 unsigned used_by_single_function : 1;
1945 private:
1946 /* Assemble thunks and aliases associated to varpool node. */
1947 void assemble_aliases (void);
1949 /* Worker for call_for_node_and_aliases. */
1950 bool call_for_symbol_and_aliases_1 (bool (*callback) (varpool_node *, void *),
1951 void *data,
1952 bool include_overwritable);
1955 /* Every top level asm statement is put into a asm_node. */
1957 struct GTY(()) asm_node {
1960 /* Next asm node. */
1961 asm_node *next;
1962 /* String for this asm node. */
1963 tree asm_str;
1964 /* Ordering of all cgraph nodes. */
1965 int order;
1968 /* Report whether or not THIS symtab node is a function, aka cgraph_node. */
1970 template <>
1971 template <>
1972 inline bool
1973 is_a_helper <cgraph_node *>::test (symtab_node *p)
1975 return p && p->type == SYMTAB_FUNCTION;
1978 /* Report whether or not THIS symtab node is a vriable, aka varpool_node. */
1980 template <>
1981 template <>
1982 inline bool
1983 is_a_helper <varpool_node *>::test (symtab_node *p)
1985 return p && p->type == SYMTAB_VARIABLE;
1988 /* Macros to access the next item in the list of free cgraph nodes and
1989 edges. */
1990 #define NEXT_FREE_NODE(NODE) dyn_cast<cgraph_node *> ((NODE)->next)
1991 #define SET_NEXT_FREE_NODE(NODE,NODE2) ((NODE))->next = NODE2
1992 #define NEXT_FREE_EDGE(EDGE) (EDGE)->prev_caller
1994 typedef void (*cgraph_edge_hook)(cgraph_edge *, void *);
1995 typedef void (*cgraph_node_hook)(cgraph_node *, void *);
1996 typedef void (*varpool_node_hook)(varpool_node *, void *);
1997 typedef void (*cgraph_2edge_hook)(cgraph_edge *, cgraph_edge *, void *);
1998 typedef void (*cgraph_2node_hook)(cgraph_node *, cgraph_node *, void *);
2000 struct cgraph_edge_hook_list;
2001 struct cgraph_node_hook_list;
2002 struct varpool_node_hook_list;
2003 struct cgraph_2edge_hook_list;
2004 struct cgraph_2node_hook_list;
2006 /* Map from a symbol to initialization/finalization priorities. */
2007 struct GTY(()) symbol_priority_map {
2008 priority_type init;
2009 priority_type fini;
2012 enum symtab_state
2014 /* Frontend is parsing and finalizing functions. */
2015 PARSING,
2016 /* Callgraph is being constructed. It is safe to add new functions. */
2017 CONSTRUCTION,
2018 /* Callgraph is being streamed-in at LTO time. */
2019 LTO_STREAMING,
2020 /* Callgraph is built and early IPA passes are being run. */
2021 IPA,
2022 /* Callgraph is built and all functions are transformed to SSA form. */
2023 IPA_SSA,
2024 /* All inline decisions are done; it is now possible to remove extern inline
2025 functions and virtual call targets. */
2026 IPA_SSA_AFTER_INLINING,
2027 /* Functions are now ordered and being passed to RTL expanders. */
2028 EXPANSION,
2029 /* All cgraph expansion is done. */
2030 FINISHED
2033 struct asmname_hasher : ggc_ptr_hash <symtab_node>
2035 typedef const_tree compare_type;
2037 static hashval_t hash (symtab_node *n);
2038 static bool equal (symtab_node *n, const_tree t);
2041 class GTY((tag ("SYMTAB"))) symbol_table
2043 public:
2044 friend class symtab_node;
2045 friend class cgraph_node;
2046 friend class cgraph_edge;
2048 symbol_table (): cgraph_max_uid (1), edges_max_uid (1)
2052 /* Initialize callgraph dump file. */
2053 void initialize (void);
2055 /* Register a top-level asm statement ASM_STR. */
2056 inline asm_node *finalize_toplevel_asm (tree asm_str);
2058 /* Analyze the whole compilation unit once it is parsed completely. */
2059 void finalize_compilation_unit (void);
2061 /* C++ frontend produce same body aliases all over the place, even before PCH
2062 gets streamed out. It relies on us linking the aliases with their function
2063 in order to do the fixups, but ipa-ref is not PCH safe. Consequentely we
2064 first produce aliases without links, but once C++ FE is sure he won't sream
2065 PCH we build the links via this function. */
2066 void process_same_body_aliases (void);
2068 /* Perform simple optimizations based on callgraph. */
2069 void compile (void);
2071 /* Process CGRAPH_NEW_FUNCTIONS and perform actions necessary to add these
2072 functions into callgraph in a way so they look like ordinary reachable
2073 functions inserted into callgraph already at construction time. */
2074 void process_new_functions (void);
2076 /* Once all functions from compilation unit are in memory, produce all clones
2077 and update all calls. We might also do this on demand if we don't want to
2078 bring all functions to memory prior compilation, but current WHOPR
2079 implementation does that and it is bit easier to keep everything right
2080 in this order. */
2081 void materialize_all_clones (void);
2083 /* Register a symbol NODE. */
2084 inline void register_symbol (symtab_node *node);
2086 inline void
2087 clear_asm_symbols (void)
2089 asmnodes = NULL;
2090 asm_last_node = NULL;
2093 /* Perform reachability analysis and reclaim all unreachable nodes. */
2094 bool remove_unreachable_nodes (FILE *file);
2096 /* Optimization of function bodies might've rendered some variables as
2097 unnecessary so we want to avoid these from being compiled. Re-do
2098 reachability starting from variables that are either externally visible
2099 or was referred from the asm output routines. */
2100 void remove_unreferenced_decls (void);
2102 /* Unregister a symbol NODE. */
2103 inline void unregister (symtab_node *node);
2105 /* Allocate new callgraph node and insert it into basic data structures. */
2106 cgraph_node *create_empty (void);
2108 /* Release a callgraph NODE. */
2109 void release_symbol (cgraph_node *node);
2111 /* Output all variables enqueued to be assembled. */
2112 bool output_variables (void);
2114 /* Weakrefs may be associated to external decls and thus not output
2115 at expansion time. Emit all necessary aliases. */
2116 void output_weakrefs (void);
2118 /* Return first static symbol with definition. */
2119 inline symtab_node *first_symbol (void);
2121 /* Return first assembler symbol. */
2122 inline asm_node *
2123 first_asm_symbol (void)
2125 return asmnodes;
2128 /* Return first static symbol with definition. */
2129 inline symtab_node *first_defined_symbol (void);
2131 /* Return first variable. */
2132 inline varpool_node *first_variable (void);
2134 /* Return next variable after NODE. */
2135 inline varpool_node *next_variable (varpool_node *node);
2137 /* Return first static variable with initializer. */
2138 inline varpool_node *first_static_initializer (void);
2140 /* Return next static variable with initializer after NODE. */
2141 inline varpool_node *next_static_initializer (varpool_node *node);
2143 /* Return first static variable with definition. */
2144 inline varpool_node *first_defined_variable (void);
2146 /* Return next static variable with definition after NODE. */
2147 inline varpool_node *next_defined_variable (varpool_node *node);
2149 /* Return first function with body defined. */
2150 inline cgraph_node *first_defined_function (void);
2152 /* Return next function with body defined after NODE. */
2153 inline cgraph_node *next_defined_function (cgraph_node *node);
2155 /* Return first function. */
2156 inline cgraph_node *first_function (void);
2158 /* Return next function. */
2159 inline cgraph_node *next_function (cgraph_node *node);
2161 /* Return first function with body defined. */
2162 cgraph_node *first_function_with_gimple_body (void);
2164 /* Return next reachable static variable with initializer after NODE. */
2165 inline cgraph_node *next_function_with_gimple_body (cgraph_node *node);
2167 /* Register HOOK to be called with DATA on each removed edge. */
2168 cgraph_edge_hook_list *add_edge_removal_hook (cgraph_edge_hook hook,
2169 void *data);
2171 /* Remove ENTRY from the list of hooks called on removing edges. */
2172 void remove_edge_removal_hook (cgraph_edge_hook_list *entry);
2174 /* Register HOOK to be called with DATA on each removed node. */
2175 cgraph_node_hook_list *add_cgraph_removal_hook (cgraph_node_hook hook,
2176 void *data);
2178 /* Remove ENTRY from the list of hooks called on removing nodes. */
2179 void remove_cgraph_removal_hook (cgraph_node_hook_list *entry);
2181 /* Register HOOK to be called with DATA on each removed node. */
2182 varpool_node_hook_list *add_varpool_removal_hook (varpool_node_hook hook,
2183 void *data);
2185 /* Remove ENTRY from the list of hooks called on removing nodes. */
2186 void remove_varpool_removal_hook (varpool_node_hook_list *entry);
2188 /* Register HOOK to be called with DATA on each inserted node. */
2189 cgraph_node_hook_list *add_cgraph_insertion_hook (cgraph_node_hook hook,
2190 void *data);
2192 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2193 void remove_cgraph_insertion_hook (cgraph_node_hook_list *entry);
2195 /* Register HOOK to be called with DATA on each inserted node. */
2196 varpool_node_hook_list *add_varpool_insertion_hook (varpool_node_hook hook,
2197 void *data);
2199 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2200 void remove_varpool_insertion_hook (varpool_node_hook_list *entry);
2202 /* Register HOOK to be called with DATA on each duplicated edge. */
2203 cgraph_2edge_hook_list *add_edge_duplication_hook (cgraph_2edge_hook hook,
2204 void *data);
2205 /* Remove ENTRY from the list of hooks called on duplicating edges. */
2206 void remove_edge_duplication_hook (cgraph_2edge_hook_list *entry);
2208 /* Register HOOK to be called with DATA on each duplicated node. */
2209 cgraph_2node_hook_list *add_cgraph_duplication_hook (cgraph_2node_hook hook,
2210 void *data);
2212 /* Remove ENTRY from the list of hooks called on duplicating nodes. */
2213 void remove_cgraph_duplication_hook (cgraph_2node_hook_list *entry);
2215 /* Call all edge removal hooks. */
2216 void call_edge_removal_hooks (cgraph_edge *e);
2218 /* Call all node insertion hooks. */
2219 void call_cgraph_insertion_hooks (cgraph_node *node);
2221 /* Call all node removal hooks. */
2222 void call_cgraph_removal_hooks (cgraph_node *node);
2224 /* Call all node duplication hooks. */
2225 void call_cgraph_duplication_hooks (cgraph_node *node, cgraph_node *node2);
2227 /* Call all edge duplication hooks. */
2228 void call_edge_duplication_hooks (cgraph_edge *cs1, cgraph_edge *cs2);
2230 /* Call all node removal hooks. */
2231 void call_varpool_removal_hooks (varpool_node *node);
2233 /* Call all node insertion hooks. */
2234 void call_varpool_insertion_hooks (varpool_node *node);
2236 /* Arrange node to be first in its entry of assembler_name_hash. */
2237 void symtab_prevail_in_asm_name_hash (symtab_node *node);
2239 /* Initalize asm name hash unless. */
2240 void symtab_initialize_asm_name_hash (void);
2242 /* Set the DECL_ASSEMBLER_NAME and update symtab hashtables. */
2243 void change_decl_assembler_name (tree decl, tree name);
2245 /* Dump symbol table to F. */
2246 void dump (FILE *f);
2248 /* Dump symbol table to stderr. */
2249 void DEBUG_FUNCTION debug (void);
2251 /* Return true if assembler names NAME1 and NAME2 leads to the same symbol
2252 name. */
2253 static bool assembler_names_equal_p (const char *name1, const char *name2);
2255 int cgraph_count;
2256 int cgraph_max_uid;
2258 int edges_count;
2259 int edges_max_uid;
2261 symtab_node* GTY(()) nodes;
2262 asm_node* GTY(()) asmnodes;
2263 asm_node* GTY(()) asm_last_node;
2264 cgraph_node* GTY(()) free_nodes;
2266 /* Head of a linked list of unused (freed) call graph edges.
2267 Do not GTY((delete)) this list so UIDs gets reliably recycled. */
2268 cgraph_edge * GTY(()) free_edges;
2270 /* The order index of the next symtab node to be created. This is
2271 used so that we can sort the cgraph nodes in order by when we saw
2272 them, to support -fno-toplevel-reorder. */
2273 int order;
2275 /* Set when whole unit has been analyzed so we can access global info. */
2276 bool global_info_ready;
2277 /* What state callgraph is in right now. */
2278 enum symtab_state state;
2279 /* Set when the cgraph is fully build and the basic flags are computed. */
2280 bool function_flags_ready;
2282 bool cpp_implicit_aliases_done;
2284 /* Hash table used to hold sectoons. */
2285 hash_table<section_name_hasher> *GTY(()) section_hash;
2287 /* Hash table used to convert assembler names into nodes. */
2288 hash_table<asmname_hasher> *assembler_name_hash;
2290 /* Hash table used to hold init priorities. */
2291 hash_map<symtab_node *, symbol_priority_map> *init_priority_hash;
2293 FILE* GTY ((skip)) dump_file;
2295 /* Return symbol used to separate symbol name from suffix. */
2296 static char symbol_suffix_separator ();
2298 FILE* GTY ((skip)) ipa_clones_dump_file;
2300 hash_set <const cgraph_node *> GTY ((skip)) cloned_nodes;
2302 private:
2303 /* Allocate new callgraph node. */
2304 inline cgraph_node * allocate_cgraph_symbol (void);
2306 /* Allocate a cgraph_edge structure and fill it with data according to the
2307 parameters of which only CALLEE can be NULL (when creating an indirect call
2308 edge). */
2309 cgraph_edge *create_edge (cgraph_node *caller, cgraph_node *callee,
2310 gcall *call_stmt, profile_count count,
2311 bool indir_unknown_callee);
2313 /* Put the edge onto the free list. */
2314 void free_edge (cgraph_edge *e);
2316 /* Insert NODE to assembler name hash. */
2317 void insert_to_assembler_name_hash (symtab_node *node, bool with_clones);
2319 /* Remove NODE from assembler name hash. */
2320 void unlink_from_assembler_name_hash (symtab_node *node, bool with_clones);
2322 /* Hash asmnames ignoring the user specified marks. */
2323 static hashval_t decl_assembler_name_hash (const_tree asmname);
2325 /* Compare ASMNAME with the DECL_ASSEMBLER_NAME of DECL. */
2326 static bool decl_assembler_name_equal (tree decl, const_tree asmname);
2328 friend struct asmname_hasher;
2330 /* List of hooks triggered when an edge is removed. */
2331 cgraph_edge_hook_list * GTY((skip)) m_first_edge_removal_hook;
2332 /* List of hooks triggem_red when a cgraph node is removed. */
2333 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_removal_hook;
2334 /* List of hooks triggered when an edge is duplicated. */
2335 cgraph_2edge_hook_list * GTY((skip)) m_first_edge_duplicated_hook;
2336 /* List of hooks triggered when a node is duplicated. */
2337 cgraph_2node_hook_list * GTY((skip)) m_first_cgraph_duplicated_hook;
2338 /* List of hooks triggered when an function is inserted. */
2339 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_insertion_hook;
2340 /* List of hooks triggered when an variable is inserted. */
2341 varpool_node_hook_list * GTY((skip)) m_first_varpool_insertion_hook;
2342 /* List of hooks triggered when a node is removed. */
2343 varpool_node_hook_list * GTY((skip)) m_first_varpool_removal_hook;
2346 extern GTY(()) symbol_table *symtab;
2348 extern vec<cgraph_node *> cgraph_new_nodes;
2350 inline hashval_t
2351 asmname_hasher::hash (symtab_node *n)
2353 return symbol_table::decl_assembler_name_hash
2354 (DECL_ASSEMBLER_NAME (n->decl));
2357 inline bool
2358 asmname_hasher::equal (symtab_node *n, const_tree t)
2360 return symbol_table::decl_assembler_name_equal (n->decl, t);
2363 /* In cgraph.c */
2364 void cgraph_c_finalize (void);
2365 void release_function_body (tree);
2366 cgraph_indirect_call_info *cgraph_allocate_init_indirect_info (void);
2368 void cgraph_update_edges_for_call_stmt (gimple *, tree, gimple *);
2369 bool cgraph_function_possibly_inlined_p (tree);
2371 const char* cgraph_inline_failed_string (cgraph_inline_failed_t);
2372 cgraph_inline_failed_type_t cgraph_inline_failed_type (cgraph_inline_failed_t);
2374 extern bool gimple_check_call_matching_types (gimple *, tree, bool);
2376 /* In cgraphunit.c */
2377 void cgraphunit_c_finalize (void);
2379 /* Initialize datastructures so DECL is a function in lowered gimple form.
2380 IN_SSA is true if the gimple is in SSA. */
2381 basic_block init_lowered_empty_function (tree, bool, profile_count);
2383 tree thunk_adjust (gimple_stmt_iterator *, tree, bool, HOST_WIDE_INT, tree,
2384 HOST_WIDE_INT);
2385 /* In cgraphclones.c */
2387 tree clone_function_name_numbered (const char *name, const char *suffix);
2388 tree clone_function_name_numbered (tree decl, const char *suffix);
2389 tree clone_function_name (const char *name, const char *suffix,
2390 unsigned long number);
2391 tree clone_function_name (tree decl, const char *suffix,
2392 unsigned long number);
2393 tree clone_function_name (tree decl, const char *suffix);
2395 void tree_function_versioning (tree, tree, vec<ipa_replace_map *, va_gc> *,
2396 bool, bitmap, bool, bitmap, basic_block);
2398 void dump_callgraph_transformation (const cgraph_node *original,
2399 const cgraph_node *clone,
2400 const char *suffix);
2401 tree cgraph_build_function_type_skip_args (tree orig_type, bitmap args_to_skip,
2402 bool skip_return);
2404 /* In cgraphbuild.c */
2405 int compute_call_stmt_bb_frequency (tree, basic_block bb);
2406 void record_references_in_initializer (tree, bool);
2408 /* In ipa.c */
2409 void cgraph_build_static_cdtor (char which, tree body, int priority);
2410 bool ipa_discover_variable_flags (void);
2412 /* In varpool.c */
2413 tree ctor_for_folding (tree);
2415 /* In ipa-inline-analysis.c */
2416 void initialize_inline_failed (struct cgraph_edge *);
2417 bool speculation_useful_p (struct cgraph_edge *e, bool anticipate_inlining);
2419 /* Return true when the symbol is real symbol, i.e. it is not inline clone
2420 or abstract function kept for debug info purposes only. */
2421 inline bool
2422 symtab_node::real_symbol_p (void)
2424 cgraph_node *cnode;
2426 if (DECL_ABSTRACT_P (decl))
2427 return false;
2428 if (transparent_alias && definition)
2429 return false;
2430 if (!is_a <cgraph_node *> (this))
2431 return true;
2432 cnode = dyn_cast <cgraph_node *> (this);
2433 if (cnode->global.inlined_to)
2434 return false;
2435 return true;
2438 /* Return true if DECL should have entry in symbol table if used.
2439 Those are functions and static & external veriables*/
2441 static inline bool
2442 decl_in_symtab_p (const_tree decl)
2444 return (TREE_CODE (decl) == FUNCTION_DECL
2445 || (TREE_CODE (decl) == VAR_DECL
2446 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl))));
2449 inline bool
2450 symtab_node::in_same_comdat_group_p (symtab_node *target)
2452 symtab_node *source = this;
2454 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2456 if (cn->global.inlined_to)
2457 source = cn->global.inlined_to;
2459 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2461 if (cn->global.inlined_to)
2462 target = cn->global.inlined_to;
2465 return source->get_comdat_group () == target->get_comdat_group ();
2468 /* Return node that alias is aliasing. */
2470 inline symtab_node *
2471 symtab_node::get_alias_target (void)
2473 ipa_ref *ref = NULL;
2474 iterate_reference (0, ref);
2475 gcc_checking_assert (ref->use == IPA_REF_ALIAS);
2476 return ref->referred;
2479 /* Return next reachable static symbol with initializer after the node. */
2481 inline symtab_node *
2482 symtab_node::next_defined_symbol (void)
2484 symtab_node *node1 = next;
2486 for (; node1; node1 = node1->next)
2487 if (node1->definition)
2488 return node1;
2490 return NULL;
2493 /* Iterates I-th reference in the list, REF is also set. */
2495 inline ipa_ref *
2496 symtab_node::iterate_reference (unsigned i, ipa_ref *&ref)
2498 vec_safe_iterate (ref_list.references, i, &ref);
2500 return ref;
2503 /* Iterates I-th referring item in the list, REF is also set. */
2505 inline ipa_ref *
2506 symtab_node::iterate_referring (unsigned i, ipa_ref *&ref)
2508 ref_list.referring.iterate (i, &ref);
2510 return ref;
2513 /* Iterates I-th referring alias item in the list, REF is also set. */
2515 inline ipa_ref *
2516 symtab_node::iterate_direct_aliases (unsigned i, ipa_ref *&ref)
2518 ref_list.referring.iterate (i, &ref);
2520 if (ref && ref->use != IPA_REF_ALIAS)
2521 return NULL;
2523 return ref;
2526 /* Return true if list contains an alias. */
2528 inline bool
2529 symtab_node::has_aliases_p (void)
2531 ipa_ref *ref = NULL;
2533 return (iterate_direct_aliases (0, ref) != NULL);
2536 /* Return true when RESOLUTION indicate that linker will use
2537 the symbol from non-LTO object files. */
2539 inline bool
2540 resolution_used_from_other_file_p (enum ld_plugin_symbol_resolution resolution)
2542 return (resolution == LDPR_PREVAILING_DEF
2543 || resolution == LDPR_PREEMPTED_REG
2544 || resolution == LDPR_RESOLVED_EXEC
2545 || resolution == LDPR_RESOLVED_DYN);
2548 /* Return true when symtab_node is known to be used from other (non-LTO)
2549 object file. Known only when doing LTO via linker plugin. */
2551 inline bool
2552 symtab_node::used_from_object_file_p (void)
2554 if (!TREE_PUBLIC (decl) || DECL_EXTERNAL (decl))
2555 return false;
2556 if (resolution_used_from_other_file_p (resolution))
2557 return true;
2558 return false;
2561 /* Return varpool node for given symbol and check it is a function. */
2563 inline varpool_node *
2564 varpool_node::get (const_tree decl)
2566 gcc_checking_assert (TREE_CODE (decl) == VAR_DECL);
2567 return dyn_cast<varpool_node *> (symtab_node::get (decl));
2570 /* Register a symbol NODE. */
2572 inline void
2573 symbol_table::register_symbol (symtab_node *node)
2575 node->next = nodes;
2576 node->previous = NULL;
2578 if (nodes)
2579 nodes->previous = node;
2580 nodes = node;
2582 node->order = order++;
2585 /* Register a top-level asm statement ASM_STR. */
2587 asm_node *
2588 symbol_table::finalize_toplevel_asm (tree asm_str)
2590 asm_node *node;
2592 node = ggc_cleared_alloc<asm_node> ();
2593 node->asm_str = asm_str;
2594 node->order = order++;
2595 node->next = NULL;
2597 if (asmnodes == NULL)
2598 asmnodes = node;
2599 else
2600 asm_last_node->next = node;
2602 asm_last_node = node;
2603 return node;
2606 /* Unregister a symbol NODE. */
2607 inline void
2608 symbol_table::unregister (symtab_node *node)
2610 if (node->previous)
2611 node->previous->next = node->next;
2612 else
2613 nodes = node->next;
2615 if (node->next)
2616 node->next->previous = node->previous;
2618 node->next = NULL;
2619 node->previous = NULL;
2622 /* Release a callgraph NODE with UID and put in to the list of free nodes. */
2624 inline void
2625 symbol_table::release_symbol (cgraph_node *node)
2627 cgraph_count--;
2629 /* Clear out the node to NULL all pointers and add the node to the free
2630 list. */
2631 memset (node, 0, sizeof (*node));
2632 node->type = SYMTAB_FUNCTION;
2633 SET_NEXT_FREE_NODE (node, free_nodes);
2634 free_nodes = node;
2637 /* Allocate new callgraph node. */
2639 inline cgraph_node *
2640 symbol_table::allocate_cgraph_symbol (void)
2642 cgraph_node *node;
2644 if (free_nodes)
2646 node = free_nodes;
2647 free_nodes = NEXT_FREE_NODE (node);
2649 else
2650 node = ggc_cleared_alloc<cgraph_node> ();
2652 node->m_uid = cgraph_max_uid++;
2653 return node;
2657 /* Return first static symbol with definition. */
2658 inline symtab_node *
2659 symbol_table::first_symbol (void)
2661 return nodes;
2664 /* Walk all symbols. */
2665 #define FOR_EACH_SYMBOL(node) \
2666 for ((node) = symtab->first_symbol (); (node); (node) = (node)->next)
2668 /* Return first static symbol with definition. */
2669 inline symtab_node *
2670 symbol_table::first_defined_symbol (void)
2672 symtab_node *node;
2674 for (node = nodes; node; node = node->next)
2675 if (node->definition)
2676 return node;
2678 return NULL;
2681 /* Walk all symbols with definitions in current unit. */
2682 #define FOR_EACH_DEFINED_SYMBOL(node) \
2683 for ((node) = symtab->first_defined_symbol (); (node); \
2684 (node) = node->next_defined_symbol ())
2686 /* Return first variable. */
2687 inline varpool_node *
2688 symbol_table::first_variable (void)
2690 symtab_node *node;
2691 for (node = nodes; node; node = node->next)
2692 if (varpool_node *vnode = dyn_cast <varpool_node *> (node))
2693 return vnode;
2694 return NULL;
2697 /* Return next variable after NODE. */
2698 inline varpool_node *
2699 symbol_table::next_variable (varpool_node *node)
2701 symtab_node *node1 = node->next;
2702 for (; node1; node1 = node1->next)
2703 if (varpool_node *vnode1 = dyn_cast <varpool_node *> (node1))
2704 return vnode1;
2705 return NULL;
2707 /* Walk all variables. */
2708 #define FOR_EACH_VARIABLE(node) \
2709 for ((node) = symtab->first_variable (); \
2710 (node); \
2711 (node) = symtab->next_variable ((node)))
2713 /* Return first static variable with initializer. */
2714 inline varpool_node *
2715 symbol_table::first_static_initializer (void)
2717 symtab_node *node;
2718 for (node = nodes; node; node = node->next)
2720 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2721 if (vnode && DECL_INITIAL (node->decl))
2722 return vnode;
2724 return NULL;
2727 /* Return next static variable with initializer after NODE. */
2728 inline varpool_node *
2729 symbol_table::next_static_initializer (varpool_node *node)
2731 symtab_node *node1 = node->next;
2732 for (; node1; node1 = node1->next)
2734 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2735 if (vnode1 && DECL_INITIAL (node1->decl))
2736 return vnode1;
2738 return NULL;
2741 /* Walk all static variables with initializer set. */
2742 #define FOR_EACH_STATIC_INITIALIZER(node) \
2743 for ((node) = symtab->first_static_initializer (); (node); \
2744 (node) = symtab->next_static_initializer (node))
2746 /* Return first static variable with definition. */
2747 inline varpool_node *
2748 symbol_table::first_defined_variable (void)
2750 symtab_node *node;
2751 for (node = nodes; node; node = node->next)
2753 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2754 if (vnode && vnode->definition)
2755 return vnode;
2757 return NULL;
2760 /* Return next static variable with definition after NODE. */
2761 inline varpool_node *
2762 symbol_table::next_defined_variable (varpool_node *node)
2764 symtab_node *node1 = node->next;
2765 for (; node1; node1 = node1->next)
2767 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2768 if (vnode1 && vnode1->definition)
2769 return vnode1;
2771 return NULL;
2773 /* Walk all variables with definitions in current unit. */
2774 #define FOR_EACH_DEFINED_VARIABLE(node) \
2775 for ((node) = symtab->first_defined_variable (); (node); \
2776 (node) = symtab->next_defined_variable (node))
2778 /* Return first function with body defined. */
2779 inline cgraph_node *
2780 symbol_table::first_defined_function (void)
2782 symtab_node *node;
2783 for (node = nodes; node; node = node->next)
2785 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2786 if (cn && cn->definition)
2787 return cn;
2789 return NULL;
2792 /* Return next function with body defined after NODE. */
2793 inline cgraph_node *
2794 symbol_table::next_defined_function (cgraph_node *node)
2796 symtab_node *node1 = node->next;
2797 for (; node1; node1 = node1->next)
2799 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2800 if (cn1 && cn1->definition)
2801 return cn1;
2803 return NULL;
2806 /* Walk all functions with body defined. */
2807 #define FOR_EACH_DEFINED_FUNCTION(node) \
2808 for ((node) = symtab->first_defined_function (); (node); \
2809 (node) = symtab->next_defined_function ((node)))
2811 /* Return first function. */
2812 inline cgraph_node *
2813 symbol_table::first_function (void)
2815 symtab_node *node;
2816 for (node = nodes; node; node = node->next)
2817 if (cgraph_node *cn = dyn_cast <cgraph_node *> (node))
2818 return cn;
2819 return NULL;
2822 /* Return next function. */
2823 inline cgraph_node *
2824 symbol_table::next_function (cgraph_node *node)
2826 symtab_node *node1 = node->next;
2827 for (; node1; node1 = node1->next)
2828 if (cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1))
2829 return cn1;
2830 return NULL;
2833 /* Return first function with body defined. */
2834 inline cgraph_node *
2835 symbol_table::first_function_with_gimple_body (void)
2837 symtab_node *node;
2838 for (node = nodes; node; node = node->next)
2840 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2841 if (cn && cn->has_gimple_body_p ())
2842 return cn;
2844 return NULL;
2847 /* Return next reachable static variable with initializer after NODE. */
2848 inline cgraph_node *
2849 symbol_table::next_function_with_gimple_body (cgraph_node *node)
2851 symtab_node *node1 = node->next;
2852 for (; node1; node1 = node1->next)
2854 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2855 if (cn1 && cn1->has_gimple_body_p ())
2856 return cn1;
2858 return NULL;
2861 /* Walk all functions. */
2862 #define FOR_EACH_FUNCTION(node) \
2863 for ((node) = symtab->first_function (); (node); \
2864 (node) = symtab->next_function ((node)))
2866 /* Return true when callgraph node is a function with Gimple body defined
2867 in current unit. Functions can also be define externally or they
2868 can be thunks with no Gimple representation.
2870 Note that at WPA stage, the function body may not be present in memory. */
2872 inline bool
2873 cgraph_node::has_gimple_body_p (void)
2875 return definition && !thunk.thunk_p && !alias;
2878 /* Walk all functions with body defined. */
2879 #define FOR_EACH_FUNCTION_WITH_GIMPLE_BODY(node) \
2880 for ((node) = symtab->first_function_with_gimple_body (); (node); \
2881 (node) = symtab->next_function_with_gimple_body (node))
2883 /* Uniquize all constants that appear in memory.
2884 Each constant in memory thus far output is recorded
2885 in `const_desc_table'. */
2887 struct GTY((for_user)) constant_descriptor_tree {
2888 /* A MEM for the constant. */
2889 rtx rtl;
2891 /* The value of the constant. */
2892 tree value;
2894 /* Hash of value. Computing the hash from value each time
2895 hashfn is called can't work properly, as that means recursive
2896 use of the hash table during hash table expansion. */
2897 hashval_t hash;
2900 /* Return true when function is only called directly or it has alias.
2901 i.e. it is not externally visible, address was not taken and
2902 it is not used in any other non-standard way. */
2904 inline bool
2905 cgraph_node::only_called_directly_or_aliased_p (void)
2907 gcc_assert (!global.inlined_to);
2908 return (!force_output && !address_taken
2909 && !ifunc_resolver
2910 && !used_from_other_partition
2911 && !DECL_VIRTUAL_P (decl)
2912 && !DECL_STATIC_CONSTRUCTOR (decl)
2913 && !DECL_STATIC_DESTRUCTOR (decl)
2914 && !used_from_object_file_p ()
2915 && !externally_visible);
2918 /* Return true when function can be removed from callgraph
2919 if all direct calls are eliminated. */
2921 inline bool
2922 cgraph_node::can_remove_if_no_direct_calls_and_refs_p (void)
2924 gcc_checking_assert (!global.inlined_to);
2925 /* Extern inlines can always go, we will use the external definition. */
2926 if (DECL_EXTERNAL (decl))
2927 return true;
2928 /* When function is needed, we can not remove it. */
2929 if (force_output || used_from_other_partition)
2930 return false;
2931 if (DECL_STATIC_CONSTRUCTOR (decl)
2932 || DECL_STATIC_DESTRUCTOR (decl))
2933 return false;
2934 /* Only COMDAT functions can be removed if externally visible. */
2935 if (externally_visible
2936 && (!DECL_COMDAT (decl)
2937 || forced_by_abi
2938 || used_from_object_file_p ()))
2939 return false;
2940 return true;
2943 /* Verify cgraph, if consistency checking is enabled. */
2945 inline void
2946 cgraph_node::checking_verify_cgraph_nodes (void)
2948 if (flag_checking)
2949 cgraph_node::verify_cgraph_nodes ();
2952 /* Return true when variable can be removed from variable pool
2953 if all direct calls are eliminated. */
2955 inline bool
2956 varpool_node::can_remove_if_no_refs_p (void)
2958 if (DECL_EXTERNAL (decl))
2959 return true;
2960 return (!force_output && !used_from_other_partition
2961 && ((DECL_COMDAT (decl)
2962 && !forced_by_abi
2963 && !used_from_object_file_p ())
2964 || !externally_visible
2965 || DECL_HAS_VALUE_EXPR_P (decl)));
2968 /* Return true when all references to variable must be visible in ipa_ref_list.
2969 i.e. if the variable is not externally visible or not used in some magic
2970 way (asm statement or such).
2971 The magic uses are all summarized in force_output flag. */
2973 inline bool
2974 varpool_node::all_refs_explicit_p ()
2976 return (definition
2977 && !externally_visible
2978 && !used_from_other_partition
2979 && !force_output);
2982 struct tree_descriptor_hasher : ggc_ptr_hash<constant_descriptor_tree>
2984 static hashval_t hash (constant_descriptor_tree *);
2985 static bool equal (constant_descriptor_tree *, constant_descriptor_tree *);
2988 /* Constant pool accessor function. */
2989 hash_table<tree_descriptor_hasher> *constant_pool_htab (void);
2991 /* Return node that alias is aliasing. */
2993 inline cgraph_node *
2994 cgraph_node::get_alias_target (void)
2996 return dyn_cast <cgraph_node *> (symtab_node::get_alias_target ());
2999 /* Return node that alias is aliasing. */
3001 inline varpool_node *
3002 varpool_node::get_alias_target (void)
3004 return dyn_cast <varpool_node *> (symtab_node::get_alias_target ());
3007 /* Walk the alias chain to return the symbol NODE is alias of.
3008 If NODE is not an alias, return NODE.
3009 When AVAILABILITY is non-NULL, get minimal availability in the chain.
3010 When REF is non-NULL, assume that reference happens in symbol REF
3011 when determining the availability. */
3013 inline symtab_node *
3014 symtab_node::ultimate_alias_target (enum availability *availability,
3015 symtab_node *ref)
3017 if (!alias)
3019 if (availability)
3020 *availability = get_availability (ref);
3021 return this;
3024 return ultimate_alias_target_1 (availability, ref);
3027 /* Given function symbol, walk the alias chain to return the function node
3028 is alias of. Do not walk through thunks.
3029 When AVAILABILITY is non-NULL, get minimal availability in the chain.
3030 When REF is non-NULL, assume that reference happens in symbol REF
3031 when determining the availability. */
3033 inline cgraph_node *
3034 cgraph_node::ultimate_alias_target (enum availability *availability,
3035 symtab_node *ref)
3037 cgraph_node *n = dyn_cast <cgraph_node *>
3038 (symtab_node::ultimate_alias_target (availability, ref));
3039 if (!n && availability)
3040 *availability = AVAIL_NOT_AVAILABLE;
3041 return n;
3044 /* For given variable pool node, walk the alias chain to return the function
3045 the variable is alias of. Do not walk through thunks.
3046 When AVAILABILITY is non-NULL, get minimal availability in the chain.
3047 When REF is non-NULL, assume that reference happens in symbol REF
3048 when determining the availability. */
3050 inline varpool_node *
3051 varpool_node::ultimate_alias_target (availability *availability,
3052 symtab_node *ref)
3054 varpool_node *n = dyn_cast <varpool_node *>
3055 (symtab_node::ultimate_alias_target (availability, ref));
3057 if (!n && availability)
3058 *availability = AVAIL_NOT_AVAILABLE;
3059 return n;
3062 /* Set callee N of call graph edge and add it to the corresponding set of
3063 callers. */
3065 inline void
3066 cgraph_edge::set_callee (cgraph_node *n)
3068 prev_caller = NULL;
3069 if (n->callers)
3070 n->callers->prev_caller = this;
3071 next_caller = n->callers;
3072 n->callers = this;
3073 callee = n;
3076 /* Redirect callee of the edge to N. The function does not update underlying
3077 call expression. */
3079 inline void
3080 cgraph_edge::redirect_callee (cgraph_node *n)
3082 /* Remove from callers list of the current callee. */
3083 remove_callee ();
3085 /* Insert to callers list of the new callee. */
3086 set_callee (n);
3089 /* Return true when the edge represents a direct recursion. */
3091 inline bool
3092 cgraph_edge::recursive_p (void)
3094 cgraph_node *c = callee->ultimate_alias_target ();
3095 if (caller->global.inlined_to)
3096 return caller->global.inlined_to->decl == c->decl;
3097 else
3098 return caller->decl == c->decl;
3101 /* Remove the edge from the list of the callers of the callee. */
3103 inline void
3104 cgraph_edge::remove_callee (void)
3106 gcc_assert (!indirect_unknown_callee);
3107 if (prev_caller)
3108 prev_caller->next_caller = next_caller;
3109 if (next_caller)
3110 next_caller->prev_caller = prev_caller;
3111 if (!prev_caller)
3112 callee->callers = next_caller;
3115 /* Return true if call must bind to current definition. */
3117 inline bool
3118 cgraph_edge::binds_to_current_def_p ()
3120 if (callee)
3121 return callee->binds_to_current_def_p (caller);
3122 else
3123 return false;
3126 /* Expected frequency of executions within the function.
3127 When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
3128 per function call. The range is 0 to CGRAPH_FREQ_MAX. */
3130 inline int
3131 cgraph_edge::frequency ()
3133 return count.to_cgraph_frequency (caller->global.inlined_to
3134 ? caller->global.inlined_to->count
3135 : caller->count);
3139 /* Return true if the TM_CLONE bit is set for a given FNDECL. */
3140 static inline bool
3141 decl_is_tm_clone (const_tree fndecl)
3143 cgraph_node *n = cgraph_node::get (fndecl);
3144 if (n)
3145 return n->tm_clone;
3146 return false;
3149 /* Likewise indicate that a node is needed, i.e. reachable via some
3150 external means. */
3152 inline void
3153 cgraph_node::mark_force_output (void)
3155 force_output = 1;
3156 gcc_checking_assert (!global.inlined_to);
3159 /* Return true if function should be optimized for size. */
3161 inline bool
3162 cgraph_node::optimize_for_size_p (void)
3164 if (opt_for_fn (decl, optimize_size))
3165 return true;
3166 if (frequency == NODE_FREQUENCY_UNLIKELY_EXECUTED)
3167 return true;
3168 else
3169 return false;
3172 /* Return symtab_node for NODE or create one if it is not present
3173 in symtab. */
3175 inline symtab_node *
3176 symtab_node::get_create (tree node)
3178 if (TREE_CODE (node) == VAR_DECL)
3179 return varpool_node::get_create (node);
3180 else
3181 return cgraph_node::get_create (node);
3184 /* Return availability of NODE when referenced from REF. */
3186 inline enum availability
3187 symtab_node::get_availability (symtab_node *ref)
3189 if (is_a <cgraph_node *> (this))
3190 return dyn_cast <cgraph_node *> (this)->get_availability (ref);
3191 else
3192 return dyn_cast <varpool_node *> (this)->get_availability (ref);
3195 /* Call calback on symtab node and aliases associated to this node.
3196 When INCLUDE_OVERWRITABLE is false, overwritable symbols are skipped. */
3198 inline bool
3199 symtab_node::call_for_symbol_and_aliases (bool (*callback) (symtab_node *,
3200 void *),
3201 void *data,
3202 bool include_overwritable)
3204 if (include_overwritable
3205 || get_availability () > AVAIL_INTERPOSABLE)
3207 if (callback (this, data))
3208 return true;
3210 if (has_aliases_p ())
3211 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3212 return false;
3215 /* Call callback on function and aliases associated to the function.
3216 When INCLUDE_OVERWRITABLE is false, overwritable symbols are
3217 skipped. */
3219 inline bool
3220 cgraph_node::call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
3221 void *),
3222 void *data,
3223 bool include_overwritable)
3225 if (include_overwritable
3226 || get_availability () > AVAIL_INTERPOSABLE)
3228 if (callback (this, data))
3229 return true;
3231 if (has_aliases_p ())
3232 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3233 return false;
3236 /* Call calback on varpool symbol and aliases associated to varpool symbol.
3237 When INCLUDE_OVERWRITABLE is false, overwritable symbols are
3238 skipped. */
3240 inline bool
3241 varpool_node::call_for_symbol_and_aliases (bool (*callback) (varpool_node *,
3242 void *),
3243 void *data,
3244 bool include_overwritable)
3246 if (include_overwritable
3247 || get_availability () > AVAIL_INTERPOSABLE)
3249 if (callback (this, data))
3250 return true;
3252 if (has_aliases_p ())
3253 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3254 return false;
3257 /* Return true if refernece may be used in address compare. */
3259 inline bool
3260 ipa_ref::address_matters_p ()
3262 if (use != IPA_REF_ADDR)
3263 return false;
3264 /* Addresses taken from virtual tables are never compared. */
3265 if (is_a <varpool_node *> (referring)
3266 && DECL_VIRTUAL_P (referring->decl))
3267 return false;
3268 return referred->address_can_be_compared_p ();
3271 /* Build polymorphic call context for indirect call E. */
3273 inline
3274 ipa_polymorphic_call_context::ipa_polymorphic_call_context (cgraph_edge *e)
3276 gcc_checking_assert (e->indirect_info->polymorphic);
3277 *this = e->indirect_info->context;
3280 /* Build empty "I know nothing" context. */
3282 inline
3283 ipa_polymorphic_call_context::ipa_polymorphic_call_context ()
3285 clear_speculation ();
3286 clear_outer_type ();
3287 invalid = false;
3290 /* Make context non-speculative. */
3292 inline void
3293 ipa_polymorphic_call_context::clear_speculation ()
3295 speculative_outer_type = NULL;
3296 speculative_offset = 0;
3297 speculative_maybe_derived_type = false;
3300 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
3301 NULL, the context is set to dummy "I know nothing" setting. */
3303 inline void
3304 ipa_polymorphic_call_context::clear_outer_type (tree otr_type)
3306 outer_type = otr_type ? TYPE_MAIN_VARIANT (otr_type) : NULL;
3307 offset = 0;
3308 maybe_derived_type = true;
3309 maybe_in_construction = true;
3310 dynamic = true;
3313 /* Adjust all offsets in contexts by OFF bits. */
3315 inline void
3316 ipa_polymorphic_call_context::offset_by (HOST_WIDE_INT off)
3318 if (outer_type)
3319 offset += off;
3320 if (speculative_outer_type)
3321 speculative_offset += off;
3324 /* Return TRUE if context is fully useless. */
3326 inline bool
3327 ipa_polymorphic_call_context::useless_p () const
3329 return (!outer_type && !speculative_outer_type);
3332 /* When using fprintf (or similar), problems can arise with
3333 transient generated strings. Many string-generation APIs
3334 only support one result being alive at once (e.g. by
3335 returning a pointer to a statically-allocated buffer).
3337 If there is more than one generated string within one
3338 fprintf call: the first string gets evicted or overwritten
3339 by the second, before fprintf is fully evaluated.
3340 See e.g. PR/53136.
3342 This function provides a workaround for this, by providing
3343 a simple way to create copies of these transient strings,
3344 without the need to have explicit cleanup:
3346 fprintf (dumpfile, "string 1: %s string 2:%s\n",
3347 xstrdup_for_dump (EXPR_1),
3348 xstrdup_for_dump (EXPR_2));
3350 This is actually a simple wrapper around ggc_strdup, but
3351 the name documents the intent. We require that no GC can occur
3352 within the fprintf call. */
3354 static inline const char *
3355 xstrdup_for_dump (const char *transient_str)
3357 return ggc_strdup (transient_str);
3360 extern GTY(()) symbol_table *saved_symtab;
3362 #if CHECKING_P
3364 namespace selftest {
3366 /* An RAII-style class for use in selftests for temporarily using a different
3367 symbol_table, so that such tests can be isolated from each other. */
3369 class symbol_table_test
3371 public:
3372 /* Constructor. Override "symtab". */
3373 symbol_table_test ();
3375 /* Destructor. Restore the saved_symtab. */
3376 ~symbol_table_test ();
3379 } // namespace selftest
3381 #endif /* CHECKING_P */
3383 #endif /* GCC_CGRAPH_H */