Make std::vector<bool> meet C++11 allocator requirements.
[official-gcc.git] / gcc / cgraph.h
blobae73f075cce0fe68bb27c35bbd36a66637ecdfe5
1 /* Callgraph handling code.
2 Copyright (C) 2003-2014 Free Software Foundation, Inc.
3 Contributed by Jan Hubicka
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
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
25 /* Symbol table consists of functions and variables.
26 TODO: add labels and CONST_DECLs. */
27 enum symtab_type
29 SYMTAB_SYMBOL,
30 SYMTAB_FUNCTION,
31 SYMTAB_VARIABLE
34 /* Section names are stored as reference counted strings in GGC safe hashtable
35 (to make them survive through PCH). */
37 struct GTY((for_user)) section_hash_entry_d
39 int ref_count;
40 char *name; /* As long as this datastructure stays in GGC, we can not put
41 string at the tail of structure of GGC dies in horrible
42 way */
45 typedef struct section_hash_entry_d section_hash_entry;
47 struct section_name_hasher : ggc_hasher<section_hash_entry *>
49 typedef const char *compare_type;
51 static hashval_t hash (section_hash_entry *);
52 static bool equal (section_hash_entry *, const char *);
55 enum availability
57 /* Not yet set by cgraph_function_body_availability. */
58 AVAIL_UNSET,
59 /* Function body/variable initializer is unknown. */
60 AVAIL_NOT_AVAILABLE,
61 /* Function body/variable initializer is known but might be replaced
62 by a different one from other compilation unit and thus needs to
63 be dealt with a care. Like AVAIL_NOT_AVAILABLE it can have
64 arbitrary side effects on escaping variables and functions, while
65 like AVAILABLE it might access static variables. */
66 AVAIL_INTERPOSABLE,
67 /* Function body/variable initializer is known and will be used in final
68 program. */
69 AVAIL_AVAILABLE,
70 /* Function body/variable initializer is known and all it's uses are
71 explicitly visible within current unit (ie it's address is never taken and
72 it is not exported to other units). Currently used only for functions. */
73 AVAIL_LOCAL
76 /* Classification of symbols WRT partitioning. */
77 enum symbol_partitioning_class
79 /* External declarations are ignored by partitioning algorithms and they are
80 added into the boundary later via compute_ltrans_boundary. */
81 SYMBOL_EXTERNAL,
82 /* Partitioned symbols are pur into one of partitions. */
83 SYMBOL_PARTITION,
84 /* Duplicated symbols (such as comdat or constant pool references) are
85 copied into every node needing them via add_symbol_to_partition. */
86 SYMBOL_DUPLICATE
89 /* Base of all entries in the symbol table.
90 The symtab_node is inherited by cgraph and varpol nodes. */
91 class GTY((desc ("%h.type"), tag ("SYMTAB_SYMBOL"),
92 chain_next ("%h.next"), chain_prev ("%h.previous")))
93 symtab_node
95 public:
96 /* Return name. */
97 const char *name () const;
99 /* Return asm name. */
100 const char * asm_name () const;
102 /* Add node into symbol table. This function is not used directly, but via
103 cgraph/varpool node creation routines. */
104 void register_symbol (void);
106 /* Remove symbol from symbol table. */
107 void remove (void);
109 /* Dump symtab node to F. */
110 void dump (FILE *f);
112 /* Dump symtab node to stderr. */
113 void DEBUG_FUNCTION debug (void);
115 /* Verify consistency of node. */
116 void DEBUG_FUNCTION verify (void);
118 /* Return ipa reference from this symtab_node to
119 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
120 of the use and STMT the statement (if it exists). */
121 ipa_ref *create_reference (symtab_node *referred_node,
122 enum ipa_ref_use use_type);
124 /* Return ipa reference from this symtab_node to
125 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
126 of the use and STMT the statement (if it exists). */
127 ipa_ref *create_reference (symtab_node *referred_node,
128 enum ipa_ref_use use_type, gimple stmt);
130 /* If VAL is a reference to a function or a variable, add a reference from
131 this symtab_node to the corresponding symbol table node. USE_TYPE specify
132 type of the use and STMT the statement (if it exists). Return the new
133 reference or NULL if none was created. */
134 ipa_ref *maybe_create_reference (tree val, enum ipa_ref_use use_type,
135 gimple stmt);
137 /* Clone all references from symtab NODE to this symtab_node. */
138 void clone_references (symtab_node *node);
140 /* Remove all stmt references in non-speculative references.
141 Those are not maintained during inlining & clonning.
142 The exception are speculative references that are updated along
143 with callgraph edges associated with them. */
144 void clone_referring (symtab_node *node);
146 /* Clone reference REF to this symtab_node and set its stmt to STMT. */
147 ipa_ref *clone_reference (ipa_ref *ref, gimple stmt);
149 /* Find the structure describing a reference to REFERRED_NODE
150 and associated with statement STMT. */
151 ipa_ref *find_reference (symtab_node *referred_node, gimple stmt,
152 unsigned int lto_stmt_uid);
154 /* Remove all references that are associated with statement STMT. */
155 void remove_stmt_references (gimple stmt);
157 /* Remove all stmt references in non-speculative references.
158 Those are not maintained during inlining & clonning.
159 The exception are speculative references that are updated along
160 with callgraph edges associated with them. */
161 void clear_stmts_in_references (void);
163 /* Remove all references in ref list. */
164 void remove_all_references (void);
166 /* Remove all referring items in ref list. */
167 void remove_all_referring (void);
169 /* Dump references in ref list to FILE. */
170 void dump_references (FILE *file);
172 /* Dump referring in list to FILE. */
173 void dump_referring (FILE *);
175 /* Get number of references for this node. */
176 inline unsigned num_references (void)
178 return ref_list.references ? ref_list.references->length () : 0;
181 /* Iterates I-th reference in the list, REF is also set. */
182 ipa_ref *iterate_reference (unsigned i, ipa_ref *&ref);
184 /* Iterates I-th referring item in the list, REF is also set. */
185 ipa_ref *iterate_referring (unsigned i, ipa_ref *&ref);
187 /* Iterates I-th referring alias item in the list, REF is also set. */
188 ipa_ref *iterate_direct_aliases (unsigned i, ipa_ref *&ref);
190 /* Return true if symtab node and TARGET represents
191 semantically equivalent symbols. */
192 bool semantically_equivalent_p (symtab_node *target);
194 /* Classify symbol symtab node for partitioning. */
195 enum symbol_partitioning_class get_partitioning_class (void);
197 /* Return comdat group. */
198 tree get_comdat_group ()
200 return x_comdat_group;
203 /* Return comdat group as identifier_node. */
204 tree get_comdat_group_id ()
206 if (x_comdat_group && TREE_CODE (x_comdat_group) != IDENTIFIER_NODE)
207 x_comdat_group = DECL_ASSEMBLER_NAME (x_comdat_group);
208 return x_comdat_group;
211 /* Set comdat group. */
212 void set_comdat_group (tree group)
214 gcc_checking_assert (!group || TREE_CODE (group) == IDENTIFIER_NODE
215 || DECL_P (group));
216 x_comdat_group = group;
219 /* Return section as string. */
220 const char * get_section ()
222 if (!x_section)
223 return NULL;
224 return x_section->name;
227 /* Remove node from same comdat group. */
228 void remove_from_same_comdat_group (void);
230 /* Add this symtab_node to the same comdat group that OLD is in. */
231 void add_to_same_comdat_group (symtab_node *old_node);
233 /* Dissolve the same_comdat_group list in which NODE resides. */
234 void dissolve_same_comdat_group_list (void);
236 /* Return true when symtab_node is known to be used from other (non-LTO)
237 object file. Known only when doing LTO via linker plugin. */
238 bool used_from_object_file_p (void);
240 /* Walk the alias chain to return the symbol NODE is alias of.
241 If NODE is not an alias, return NODE.
242 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
243 symtab_node *ultimate_alias_target (enum availability *avail = NULL);
245 /* Return next reachable static symbol with initializer after NODE. */
246 inline symtab_node *next_defined_symbol (void);
248 /* Add reference recording that symtab node is alias of TARGET.
249 The function can fail in the case of aliasing cycles; in this case
250 it returns false. */
251 bool resolve_alias (symtab_node *target);
253 /* C++ FE sometimes change linkage flags after producing same
254 body aliases. */
255 void fixup_same_cpp_alias_visibility (symtab_node *target);
257 /* Call calback on symtab node and aliases associated to this node.
258 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
259 skipped. */
260 bool call_for_symbol_and_aliases (bool (*callback) (symtab_node *, void *),
261 void *data,
262 bool include_overwrite);
264 /* If node can not be interposable by static or dynamic linker to point to
265 different definition, return this symbol. Otherwise look for alias with
266 such property and if none exists, introduce new one. */
267 symtab_node *noninterposable_alias (void);
269 /* Return node that alias is aliasing. */
270 inline symtab_node *get_alias_target (void);
272 /* Set section for symbol and its aliases. */
273 void set_section (const char *section);
275 /* Set section, do not recurse into aliases.
276 When one wants to change section of symbol and its aliases,
277 use set_section. */
278 void set_section_for_node (const char *section);
280 /* Set initialization priority to PRIORITY. */
281 void set_init_priority (priority_type priority);
283 /* Return the initialization priority. */
284 priority_type get_init_priority ();
286 /* Return availability of NODE. */
287 enum availability get_availability (void);
289 /* Make DECL local. */
290 void make_decl_local (void);
292 /* Return true if list contains an alias. */
293 bool has_aliases_p (void);
295 /* Return true when the symbol is real symbol, i.e. it is not inline clone
296 or abstract function kept for debug info purposes only. */
297 bool real_symbol_p (void);
299 /* Determine if symbol declaration is needed. That is, visible to something
300 either outside this translation unit, something magic in the system
301 configury. This function is used just during symbol creation. */
302 bool needed_p (void);
304 /* Return true when there are references to the node. */
305 bool referred_to_p (void);
307 /* Return true if NODE can be discarded by linker from the binary. */
308 inline bool
309 can_be_discarded_p (void)
311 return (DECL_EXTERNAL (decl)
312 || (get_comdat_group ()
313 && resolution != LDPR_PREVAILING_DEF
314 && resolution != LDPR_PREVAILING_DEF_IRONLY
315 && resolution != LDPR_PREVAILING_DEF_IRONLY_EXP));
318 /* Return true if NODE is local to a particular COMDAT group, and must not
319 be named from outside the COMDAT. This is used for C++ decloned
320 constructors. */
321 inline bool comdat_local_p (void)
323 return (same_comdat_group && !TREE_PUBLIC (decl));
326 /* Return true if ONE and TWO are part of the same COMDAT group. */
327 inline bool in_same_comdat_group_p (symtab_node *target);
329 /* Return true when there is a reference to node and it is not vtable. */
330 bool address_taken_from_non_vtable_p (void);
332 /* Return true if symbol is known to be nonzero. */
333 bool nonzero_address ();
335 /* Return symbol table node associated with DECL, if any,
336 and NULL otherwise. */
337 static inline symtab_node *get (const_tree decl)
339 #ifdef ENABLE_CHECKING
340 /* Check that we are called for sane type of object - functions
341 and static or external variables. */
342 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL
343 || (TREE_CODE (decl) == VAR_DECL
344 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl)
345 || in_lto_p)));
346 /* Check that the mapping is sane - perhaps this check can go away,
347 but at the moment frontends tends to corrupt the mapping by calling
348 memcpy/memset on the tree nodes. */
349 gcc_checking_assert (!decl->decl_with_vis.symtab_node
350 || decl->decl_with_vis.symtab_node->decl == decl);
351 #endif
352 return decl->decl_with_vis.symtab_node;
355 /* Try to find a symtab node for declaration DECL and if it does not
356 exist or if it corresponds to an inline clone, create a new one. */
357 static inline symtab_node * get_create (tree node);
359 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
360 Return NULL if there's no such node. */
361 static symtab_node *get_for_asmname (const_tree asmname);
363 /* Dump symbol table to F. */
364 static void dump_table (FILE *);
366 /* Dump symbol table to stderr. */
367 static inline DEBUG_FUNCTION void debug_symtab (void)
369 dump_table (stderr);
372 /* Verify symbol table for internal consistency. */
373 static DEBUG_FUNCTION void verify_symtab_nodes (void);
375 /* Return true when NODE is known to be used from other (non-LTO)
376 object file. Known only when doing LTO via linker plugin. */
377 static bool used_from_object_file_p_worker (symtab_node *node);
379 /* Type of the symbol. */
380 ENUM_BITFIELD (symtab_type) type : 8;
382 /* The symbols resolution. */
383 ENUM_BITFIELD (ld_plugin_symbol_resolution) resolution : 8;
385 /*** Flags representing the symbol type. ***/
387 /* True when symbol corresponds to a definition in current unit.
388 set via finalize_function or finalize_decl */
389 unsigned definition : 1;
390 /* True when symbol is an alias.
391 Set by ssemble_alias. */
392 unsigned alias : 1;
393 /* True when alias is a weakref. */
394 unsigned weakref : 1;
395 /* C++ frontend produce same body aliases and extra name aliases for
396 virtual functions and vtables that are obviously equivalent.
397 Those aliases are bit special, especially because C++ frontend
398 visibility code is so ugly it can not get them right at first time
399 and their visibility needs to be copied from their "masters" at
400 the end of parsing. */
401 unsigned cpp_implicit_alias : 1;
402 /* Set once the definition was analyzed. The list of references and
403 other properties are built during analysis. */
404 unsigned analyzed : 1;
405 /* Set for write-only variables. */
406 unsigned writeonly : 1;
407 /* Visibility of symbol was used for further optimization; do not
408 permit further changes. */
409 unsigned refuse_visibility_changes : 1;
411 /*** Visibility and linkage flags. ***/
413 /* Set when function is visible by other units. */
414 unsigned externally_visible : 1;
415 /* Don't reorder to other symbols having this set. */
416 unsigned no_reorder : 1;
417 /* The symbol will be assumed to be used in an invisible way (like
418 by an toplevel asm statement). */
419 unsigned force_output : 1;
420 /* Like FORCE_OUTPUT, but in the case it is ABI requiring the symbol to be
421 exported. Unlike FORCE_OUTPUT this flag gets cleared to symbols promoted
422 to static and it does not inhibit optimization. */
423 unsigned forced_by_abi : 1;
424 /* True when the name is known to be unique and thus it does not need mangling. */
425 unsigned unique_name : 1;
426 /* Specify whether the section was set by user or by
427 compiler via -ffunction-sections. */
428 unsigned implicit_section : 1;
429 /* True when body and other characteristics have been removed by
430 symtab_remove_unreachable_nodes. */
431 unsigned body_removed : 1;
433 /*** WHOPR Partitioning flags.
434 These flags are used at ltrans stage when only part of the callgraph is
435 available. ***/
437 /* Set when variable is used from other LTRANS partition. */
438 unsigned used_from_other_partition : 1;
439 /* Set when function is available in the other LTRANS partition.
440 During WPA output it is used to mark nodes that are present in
441 multiple partitions. */
442 unsigned in_other_partition : 1;
446 /*** other flags. ***/
448 /* Set when symbol has address taken. */
449 unsigned address_taken : 1;
450 /* Set when init priority is set. */
451 unsigned in_init_priority_hash : 1;
454 /* Ordering of all symtab entries. */
455 int order;
457 /* Declaration representing the symbol. */
458 tree decl;
460 /* Linked list of symbol table entries starting with symtab_nodes. */
461 symtab_node *next;
462 symtab_node *previous;
464 /* Linked list of symbols with the same asm name. There may be multiple
465 entries for single symbol name during LTO, because symbols are renamed
466 only after partitioning.
468 Because inline clones are kept in the assembler name has, they also produce
469 duplicate entries.
471 There are also several long standing bugs where frontends and builtin
472 code produce duplicated decls. */
473 symtab_node *next_sharing_asm_name;
474 symtab_node *previous_sharing_asm_name;
476 /* Circular list of nodes in the same comdat group if non-NULL. */
477 symtab_node *same_comdat_group;
479 /* Vectors of referring and referenced entities. */
480 ipa_ref_list ref_list;
482 /* Alias target. May be either DECL pointer or ASSEMBLER_NAME pointer
483 depending to what was known to frontend on the creation time.
484 Once alias is resolved, this pointer become NULL. */
485 tree alias_target;
487 /* File stream where this node is being written to. */
488 struct lto_file_decl_data * lto_file_data;
490 PTR GTY ((skip)) aux;
492 /* Comdat group the symbol is in. Can be private if GGC allowed that. */
493 tree x_comdat_group;
495 /* Section name. Again can be private, if allowed. */
496 section_hash_entry *x_section;
498 protected:
499 /* Dump base fields of symtab nodes to F. Not to be used directly. */
500 void dump_base (FILE *);
502 /* Verify common part of symtab node. */
503 bool DEBUG_FUNCTION verify_base (void);
505 /* Remove node from symbol table. This function is not used directly, but via
506 cgraph/varpool node removal routines. */
507 void unregister (void);
509 /* Return the initialization and finalization priority information for
510 DECL. If there is no previous priority information, a freshly
511 allocated structure is returned. */
512 struct symbol_priority_map *priority_info (void);
514 private:
515 /* Worker for set_section. */
516 static bool set_section (symtab_node *n, void *s);
518 /* Worker for symtab_resolve_alias. */
519 static bool set_implicit_section (symtab_node *n, void *);
521 /* Worker searching noninterposable alias. */
522 static bool noninterposable_alias (symtab_node *node, void *data);
525 /* Walk all aliases for NODE. */
526 #define FOR_EACH_ALIAS(node, alias) \
527 for (unsigned x_i = 0; node->iterate_direct_aliases (x_i, alias); x_i++)
529 /* This is the information that is put into the cgraph local structure
530 to recover a function. */
531 struct lto_file_decl_data;
533 extern const char * const cgraph_availability_names[];
534 extern const char * const ld_plugin_symbol_resolution_names[];
535 extern const char * const tls_model_names[];
537 /* Information about thunk, used only for same body aliases. */
539 struct GTY(()) cgraph_thunk_info {
540 /* Information about the thunk. */
541 HOST_WIDE_INT fixed_offset;
542 HOST_WIDE_INT virtual_value;
543 tree alias;
544 bool this_adjusting;
545 bool virtual_offset_p;
546 /* Set to true when alias node is thunk. */
547 bool thunk_p;
550 /* Information about the function collected locally.
551 Available after function is analyzed. */
553 struct GTY(()) cgraph_local_info {
554 /* Set when function function is visible in current compilation unit only
555 and its address is never taken. */
556 unsigned local : 1;
558 /* False when there is something makes versioning impossible. */
559 unsigned versionable : 1;
561 /* False when function calling convention and signature can not be changed.
562 This is the case when __builtin_apply_args is used. */
563 unsigned can_change_signature : 1;
565 /* True when the function has been originally extern inline, but it is
566 redefined now. */
567 unsigned redefined_extern_inline : 1;
569 /* True if the function may enter serial irrevocable mode. */
570 unsigned tm_may_enter_irr : 1;
573 /* Information about the function that needs to be computed globally
574 once compilation is finished. Available only with -funit-at-a-time. */
576 struct GTY(()) cgraph_global_info {
577 /* For inline clones this points to the function they will be
578 inlined into. */
579 cgraph_node *inlined_to;
582 /* Information about the function that is propagated by the RTL backend.
583 Available only for functions that has been already assembled. */
585 struct GTY(()) cgraph_rtl_info {
586 unsigned int preferred_incoming_stack_boundary;
588 /* Call unsaved hard registers really used by the corresponding
589 function (including ones used by functions called by the
590 function). */
591 HARD_REG_SET function_used_regs;
592 /* Set if function_used_regs is valid. */
593 unsigned function_used_regs_valid: 1;
596 /* Represent which DECL tree (or reference to such tree)
597 will be replaced by another tree while versioning. */
598 struct GTY(()) ipa_replace_map
600 /* The tree that will be replaced. */
601 tree old_tree;
602 /* The new (replacing) tree. */
603 tree new_tree;
604 /* Parameter number to replace, when old_tree is NULL. */
605 int parm_num;
606 /* True when a substitution should be done, false otherwise. */
607 bool replace_p;
608 /* True when we replace a reference to old_tree. */
609 bool ref_p;
612 struct GTY(()) cgraph_clone_info
614 vec<ipa_replace_map *, va_gc> *tree_map;
615 bitmap args_to_skip;
616 bitmap combined_args_to_skip;
619 enum cgraph_simd_clone_arg_type
621 SIMD_CLONE_ARG_TYPE_VECTOR,
622 SIMD_CLONE_ARG_TYPE_UNIFORM,
623 SIMD_CLONE_ARG_TYPE_LINEAR_CONSTANT_STEP,
624 SIMD_CLONE_ARG_TYPE_LINEAR_VARIABLE_STEP,
625 SIMD_CLONE_ARG_TYPE_MASK
628 /* Function arguments in the original function of a SIMD clone.
629 Supplementary data for `struct simd_clone'. */
631 struct GTY(()) cgraph_simd_clone_arg {
632 /* Original function argument as it originally existed in
633 DECL_ARGUMENTS. */
634 tree orig_arg;
636 /* orig_arg's function (or for extern functions type from
637 TYPE_ARG_TYPES). */
638 tree orig_type;
640 /* If argument is a vector, this holds the vector version of
641 orig_arg that after adjusting the argument types will live in
642 DECL_ARGUMENTS. Otherwise, this is NULL.
644 This basically holds:
645 vector(simdlen) __typeof__(orig_arg) new_arg. */
646 tree vector_arg;
648 /* vector_arg's type (or for extern functions new vector type. */
649 tree vector_type;
651 /* If argument is a vector, this holds the array where the simd
652 argument is held while executing the simd clone function. This
653 is a local variable in the cloned function. Its content is
654 copied from vector_arg upon entry to the clone.
656 This basically holds:
657 __typeof__(orig_arg) simd_array[simdlen]. */
658 tree simd_array;
660 /* A SIMD clone's argument can be either linear (constant or
661 variable), uniform, or vector. */
662 enum cgraph_simd_clone_arg_type arg_type;
664 /* For arg_type SIMD_CLONE_ARG_TYPE_LINEAR_CONSTANT_STEP this is
665 the constant linear step, if arg_type is
666 SIMD_CLONE_ARG_TYPE_LINEAR_VARIABLE_STEP, this is index of
667 the uniform argument holding the step, otherwise 0. */
668 HOST_WIDE_INT linear_step;
670 /* Variable alignment if available, otherwise 0. */
671 unsigned int alignment;
674 /* Specific data for a SIMD function clone. */
676 struct GTY(()) cgraph_simd_clone {
677 /* Number of words in the SIMD lane associated with this clone. */
678 unsigned int simdlen;
680 /* Number of annotated function arguments in `args'. This is
681 usually the number of named arguments in FNDECL. */
682 unsigned int nargs;
684 /* Max hardware vector size in bits for integral vectors. */
685 unsigned int vecsize_int;
687 /* Max hardware vector size in bits for floating point vectors. */
688 unsigned int vecsize_float;
690 /* The mangling character for a given vector size. This is is used
691 to determine the ISA mangling bit as specified in the Intel
692 Vector ABI. */
693 unsigned char vecsize_mangle;
695 /* True if this is the masked, in-branch version of the clone,
696 otherwise false. */
697 unsigned int inbranch : 1;
699 /* True if this is a Cilk Plus variant. */
700 unsigned int cilk_elemental : 1;
702 /* Doubly linked list of SIMD clones. */
703 cgraph_node *prev_clone, *next_clone;
705 /* Original cgraph node the SIMD clones were created for. */
706 cgraph_node *origin;
708 /* Annotated function arguments for the original function. */
709 cgraph_simd_clone_arg GTY((length ("%h.nargs"))) args[1];
712 /* Function Multiversioning info. */
713 struct GTY((for_user)) cgraph_function_version_info {
714 /* The cgraph_node for which the function version info is stored. */
715 cgraph_node *this_node;
716 /* Chains all the semantically identical function versions. The
717 first function in this chain is the version_info node of the
718 default function. */
719 cgraph_function_version_info *prev;
720 /* If this version node corresponds to a dispatcher for function
721 versions, this points to the version info node of the default
722 function, the first node in the chain. */
723 cgraph_function_version_info *next;
724 /* If this node corresponds to a function version, this points
725 to the dispatcher function decl, which is the function that must
726 be called to execute the right function version at run-time.
728 If this cgraph node is a dispatcher (if dispatcher_function is
729 true, in the cgraph_node struct) for function versions, this
730 points to resolver function, which holds the function body of the
731 dispatcher. The dispatcher decl is an alias to the resolver
732 function decl. */
733 tree dispatcher_resolver;
736 #define DEFCIFCODE(code, type, string) CIF_ ## code,
737 /* Reasons for inlining failures. */
739 enum cgraph_inline_failed_t {
740 #include "cif-code.def"
741 CIF_N_REASONS
744 enum cgraph_inline_failed_type_t
746 CIF_FINAL_NORMAL = 0,
747 CIF_FINAL_ERROR
750 struct cgraph_edge;
752 struct cgraph_edge_hasher : ggc_hasher<cgraph_edge *>
754 typedef gimple compare_type;
756 static hashval_t hash (cgraph_edge *);
757 static bool equal (cgraph_edge *, gimple);
760 /* The cgraph data structure.
761 Each function decl has assigned cgraph_node listing callees and callers. */
763 struct GTY((tag ("SYMTAB_FUNCTION"))) cgraph_node : public symtab_node {
764 public:
765 /* Remove the node from cgraph and all inline clones inlined into it.
766 Skip however removal of FORBIDDEN_NODE and return true if it needs to be
767 removed. This allows to call the function from outer loop walking clone
768 tree. */
769 bool remove_symbol_and_inline_clones (cgraph_node *forbidden_node = NULL);
771 /* Record all references from cgraph_node that are taken
772 in statement STMT. */
773 void record_stmt_references (gimple stmt);
775 /* Like cgraph_set_call_stmt but walk the clone tree and update all
776 clones sharing the same function body.
777 When WHOLE_SPECULATIVE_EDGES is true, all three components of
778 speculative edge gets updated. Otherwise we update only direct
779 call. */
780 void set_call_stmt_including_clones (gimple old_stmt, gimple new_stmt,
781 bool update_speculative = true);
783 /* Walk the alias chain to return the function cgraph_node is alias of.
784 Walk through thunk, too.
785 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
786 cgraph_node *function_symbol (enum availability *avail = NULL);
788 /* Create node representing clone of N executed COUNT times. Decrease
789 the execution counts from original node too.
790 The new clone will have decl set to DECL that may or may not be the same
791 as decl of N.
793 When UPDATE_ORIGINAL is true, the counts are subtracted from the original
794 function's profile to reflect the fact that part of execution is handled
795 by node.
796 When CALL_DUPLICATOIN_HOOK is true, the ipa passes are acknowledged about
797 the new clone. Otherwise the caller is responsible for doing so later.
799 If the new node is being inlined into another one, NEW_INLINED_TO should be
800 the outline function the new one is (even indirectly) inlined to.
801 All hooks will see this in node's global.inlined_to, when invoked.
802 Can be NULL if the node is not inlined. */
803 cgraph_node *create_clone (tree decl, gcov_type count, int freq,
804 bool update_original,
805 vec<cgraph_edge *> redirect_callers,
806 bool call_duplication_hook,
807 cgraph_node *new_inlined_to,
808 bitmap args_to_skip);
810 /* Create callgraph node clone with new declaration. The actual body will
811 be copied later at compilation stage. */
812 cgraph_node *create_virtual_clone (vec<cgraph_edge *> redirect_callers,
813 vec<ipa_replace_map *, va_gc> *tree_map,
814 bitmap args_to_skip, const char * suffix);
816 /* cgraph node being removed from symbol table; see if its entry can be
817 replaced by other inline clone. */
818 cgraph_node *find_replacement (void);
820 /* Create a new cgraph node which is the new version of
821 callgraph node. REDIRECT_CALLERS holds the callers
822 edges which should be redirected to point to
823 NEW_VERSION. ALL the callees edges of the node
824 are cloned to the new version node. Return the new
825 version node.
827 If non-NULL BLOCK_TO_COPY determine what basic blocks
828 was copied to prevent duplications of calls that are dead
829 in the clone. */
831 cgraph_node *create_version_clone (tree new_decl,
832 vec<cgraph_edge *> redirect_callers,
833 bitmap bbs_to_copy);
835 /* Perform function versioning.
836 Function versioning includes copying of the tree and
837 a callgraph update (creating a new cgraph node and updating
838 its callees and callers).
840 REDIRECT_CALLERS varray includes the edges to be redirected
841 to the new version.
843 TREE_MAP is a mapping of tree nodes we want to replace with
844 new ones (according to results of prior analysis).
846 If non-NULL ARGS_TO_SKIP determine function parameters to remove
847 from new version.
848 If SKIP_RETURN is true, the new version will return void.
849 If non-NULL BLOCK_TO_COPY determine what basic blocks to copy.
850 If non_NULL NEW_ENTRY determine new entry BB of the clone.
852 Return the new version's cgraph node. */
853 cgraph_node *create_version_clone_with_body
854 (vec<cgraph_edge *> redirect_callers,
855 vec<ipa_replace_map *, va_gc> *tree_map, bitmap args_to_skip,
856 bool skip_return, bitmap bbs_to_copy, basic_block new_entry_block,
857 const char *clone_name);
859 /* Insert a new cgraph_function_version_info node into cgraph_fnver_htab
860 corresponding to cgraph_node. */
861 cgraph_function_version_info *insert_new_function_version (void);
863 /* Get the cgraph_function_version_info node corresponding to node. */
864 cgraph_function_version_info *function_version (void);
866 /* Discover all functions and variables that are trivially needed, analyze
867 them as well as all functions and variables referred by them */
868 void analyze (void);
870 /* Add thunk alias into callgraph. The alias declaration is ALIAS and it
871 aliases DECL with an adjustments made into the first parameter.
872 See comments in thunk_adjust for detail on the parameters. */
873 cgraph_node * create_thunk (tree alias, tree, bool this_adjusting,
874 HOST_WIDE_INT fixed_offset,
875 HOST_WIDE_INT virtual_value,
876 tree virtual_offset,
877 tree real_alias);
880 /* Return node that alias is aliasing. */
881 inline cgraph_node *get_alias_target (void);
883 /* Given function symbol, walk the alias chain to return the function node
884 is alias of. Do not walk through thunks.
885 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
887 cgraph_node *ultimate_alias_target (availability *availability = NULL);
889 /* Expand thunk NODE to gimple if possible.
890 When FORCE_GIMPLE_THUNK is true, gimple thunk is created and
891 no assembler is produced.
892 When OUTPUT_ASM_THUNK is true, also produce assembler for
893 thunks that are not lowered. */
894 bool expand_thunk (bool output_asm_thunks, bool force_gimple_thunk);
896 /* Assemble thunks and aliases associated to node. */
897 void assemble_thunks_and_aliases (void);
899 /* Expand function specified by node. */
900 void expand (void);
902 /* As an GCC extension we allow redefinition of the function. The
903 semantics when both copies of bodies differ is not well defined.
904 We replace the old body with new body so in unit at a time mode
905 we always use new body, while in normal mode we may end up with
906 old body inlined into some functions and new body expanded and
907 inlined in others. */
908 void reset (void);
910 /* Creates a wrapper from cgraph_node to TARGET node. Thunk is used for this
911 kind of wrapper method. */
912 void create_wrapper (cgraph_node *target);
914 /* Verify cgraph nodes of the cgraph node. */
915 void DEBUG_FUNCTION verify_node (void);
917 /* Remove function from symbol table. */
918 void remove (void);
920 /* Dump call graph node to file F. */
921 void dump (FILE *f);
923 /* Dump call graph node to stderr. */
924 void DEBUG_FUNCTION debug (void);
926 /* When doing LTO, read cgraph_node's body from disk if it is not already
927 present. */
928 bool get_body (void);
930 /* Release memory used to represent body of function.
931 Use this only for functions that are released before being translated to
932 target code (i.e. RTL). Functions that are compiled to RTL and beyond
933 are free'd in final.c via free_after_compilation(). */
934 void release_body (bool keep_arguments = false);
936 /* Return the DECL_STRUCT_FUNCTION of the function. */
937 struct function *get_fun (void);
939 /* cgraph_node is no longer nested function; update cgraph accordingly. */
940 void unnest (void);
942 /* Bring cgraph node local. */
943 void make_local (void);
945 /* Likewise indicate that a node is having address taken. */
946 void mark_address_taken (void);
948 /* Set fialization priority to PRIORITY. */
949 void set_fini_priority (priority_type priority);
951 /* Return the finalization priority. */
952 priority_type get_fini_priority (void);
954 /* Create edge from a given function to CALLEE in the cgraph. */
955 cgraph_edge *create_edge (cgraph_node *callee,
956 gimple call_stmt, gcov_type count,
957 int freq);
959 /* Create an indirect edge with a yet-undetermined callee where the call
960 statement destination is a formal parameter of the caller with index
961 PARAM_INDEX. */
962 cgraph_edge *create_indirect_edge (gimple call_stmt, int ecf_flags,
963 gcov_type count, int freq,
964 bool compute_indirect_info = true);
966 /* Like cgraph_create_edge walk the clone tree and update all clones sharing
967 same function body. If clones already have edge for OLD_STMT; only
968 update the edge same way as cgraph_set_call_stmt_including_clones does. */
969 void create_edge_including_clones (cgraph_node *callee,
970 gimple old_stmt, gimple stmt,
971 gcov_type count,
972 int freq,
973 cgraph_inline_failed_t reason);
975 /* Return the callgraph edge representing the GIMPLE_CALL statement
976 CALL_STMT. */
977 cgraph_edge *get_edge (gimple call_stmt);
979 /* Collect all callers of cgraph_node and its aliases that are known to lead
980 to NODE (i.e. are not overwritable). */
981 vec<cgraph_edge *> collect_callers (void);
983 /* Remove all callers from the node. */
984 void remove_callers (void);
986 /* Remove all callees from the node. */
987 void remove_callees (void);
989 /* Return function availability. See cgraph.h for description of individual
990 return values. */
991 enum availability get_availability (void);
993 /* Set TREE_NOTHROW on cgraph_node's decl and on aliases of the node
994 if any to NOTHROW. */
995 void set_nothrow_flag (bool nothrow);
997 /* Set TREE_READONLY on cgraph_node's decl and on aliases of the node
998 if any to READONLY. */
999 void set_const_flag (bool readonly, bool looping);
1001 /* Set DECL_PURE_P on cgraph_node's decl and on aliases of the node
1002 if any to PURE. */
1003 void set_pure_flag (bool pure, bool looping);
1005 /* Call calback on function and aliases associated to the function.
1006 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1007 skipped. */
1009 bool call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
1010 void *),
1011 void *data, bool include_overwritable);
1013 /* Call calback on cgraph_node, thunks and aliases associated to NODE.
1014 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1015 skipped. */
1016 bool call_for_symbol_thunks_and_aliases (bool (*callback) (cgraph_node *node,
1017 void *data),
1018 void *data,
1019 bool include_overwritable);
1021 /* Likewise indicate that a node is needed, i.e. reachable via some
1022 external means. */
1023 inline void mark_force_output (void);
1025 /* Return true when function can be marked local. */
1026 bool local_p (void);
1028 /* Return true if cgraph_node can be made local for API change.
1029 Extern inline functions and C++ COMDAT functions can be made local
1030 at the expense of possible code size growth if function is used in multiple
1031 compilation units. */
1032 bool can_be_local_p (void);
1034 /* Return true when cgraph_node can not return or throw and thus
1035 it is safe to ignore its side effects for IPA analysis. */
1036 bool cannot_return_p (void);
1038 /* Return true when function cgraph_node and all its aliases are only called
1039 directly.
1040 i.e. it is not externally visible, address was not taken and
1041 it is not used in any other non-standard way. */
1042 bool only_called_directly_p (void);
1044 /* Return true when function is only called directly or it has alias.
1045 i.e. it is not externally visible, address was not taken and
1046 it is not used in any other non-standard way. */
1047 inline bool only_called_directly_or_aliased_p (void);
1049 /* Return true when function cgraph_node can be expected to be removed
1050 from program when direct calls in this compilation unit are removed.
1052 As a special case COMDAT functions are
1053 cgraph_can_remove_if_no_direct_calls_p while the are not
1054 cgraph_only_called_directly_p (it is possible they are called from other
1055 unit)
1057 This function behaves as cgraph_only_called_directly_p because eliminating
1058 all uses of COMDAT function does not make it necessarily disappear from
1059 the program unless we are compiling whole program or we do LTO. In this
1060 case we know we win since dynamic linking will not really discard the
1061 linkonce section. */
1062 bool will_be_removed_from_program_if_no_direct_calls_p (void);
1064 /* Return true when function can be removed from callgraph
1065 if all direct calls are eliminated. */
1066 bool can_remove_if_no_direct_calls_and_refs_p (void);
1068 /* Return true when function cgraph_node and its aliases can be removed from
1069 callgraph if all direct calls are eliminated. */
1070 bool can_remove_if_no_direct_calls_p (void);
1072 /* Return true when callgraph node is a function with Gimple body defined
1073 in current unit. Functions can also be define externally or they
1074 can be thunks with no Gimple representation.
1076 Note that at WPA stage, the function body may not be present in memory. */
1077 inline bool has_gimple_body_p (void);
1079 /* Return true if function should be optimized for size. */
1080 bool optimize_for_size_p (void);
1082 /* Dump the callgraph to file F. */
1083 static void dump_cgraph (FILE *f);
1085 /* Dump the call graph to stderr. */
1086 static inline
1087 void debug_cgraph (void)
1089 dump_cgraph (stderr);
1092 /* Record that DECL1 and DECL2 are semantically identical function
1093 versions. */
1094 static void record_function_versions (tree decl1, tree decl2);
1096 /* Remove the cgraph_function_version_info and cgraph_node for DECL. This
1097 DECL is a duplicate declaration. */
1098 static void delete_function_version (tree decl);
1100 /* Add the function FNDECL to the call graph.
1101 Unlike finalize_function, this function is intended to be used
1102 by middle end and allows insertion of new function at arbitrary point
1103 of compilation. The function can be either in high, low or SSA form
1104 GIMPLE.
1106 The function is assumed to be reachable and have address taken (so no
1107 API breaking optimizations are performed on it).
1109 Main work done by this function is to enqueue the function for later
1110 processing to avoid need the passes to be re-entrant. */
1111 static void add_new_function (tree fndecl, bool lowered);
1113 /* Return callgraph node for given symbol and check it is a function. */
1114 static inline cgraph_node *get (const_tree decl)
1116 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL);
1117 return dyn_cast <cgraph_node *> (symtab_node::get (decl));
1120 /* DECL has been parsed. Take it, queue it, compile it at the whim of the
1121 logic in effect. If NO_COLLECT is true, then our caller cannot stand to
1122 have the garbage collector run at the moment. We would need to either
1123 create a new GC context, or just not compile right now. */
1124 static void finalize_function (tree, bool);
1126 /* Return cgraph node assigned to DECL. Create new one when needed. */
1127 static cgraph_node * create (tree decl);
1129 /* Try to find a call graph node for declaration DECL and if it does not
1130 exist or if it corresponds to an inline clone, create a new one. */
1131 static cgraph_node * get_create (tree);
1133 /* Return local info for the compiled function. */
1134 static cgraph_local_info *local_info (tree decl);
1136 /* Return global info for the compiled function. */
1137 static cgraph_global_info *global_info (tree);
1139 /* Return local info for the compiled function. */
1140 static cgraph_rtl_info *rtl_info (tree);
1142 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
1143 Return NULL if there's no such node. */
1144 static cgraph_node *get_for_asmname (tree asmname);
1146 /* Attempt to mark ALIAS as an alias to DECL. Return alias node if
1147 successful and NULL otherwise.
1148 Same body aliases are output whenever the body of DECL is output,
1149 and cgraph_node::get (ALIAS) transparently
1150 returns cgraph_node::get (DECL). */
1151 static cgraph_node * create_same_body_alias (tree alias, tree decl);
1153 /* Worker for cgraph_can_remove_if_no_direct_calls_p. */
1154 static bool used_from_object_file_p_worker (cgraph_node *node, void *)
1156 return node->used_from_object_file_p ();
1159 /* Return true when cgraph_node can not be local.
1160 Worker for cgraph_local_node_p. */
1161 static bool non_local_p (cgraph_node *node, void *);
1163 /* Verify whole cgraph structure. */
1164 static void DEBUG_FUNCTION verify_cgraph_nodes (void);
1166 /* Worker to bring NODE local. */
1167 static bool make_local (cgraph_node *node, void *);
1169 /* Mark ALIAS as an alias to DECL. DECL_NODE is cgraph node representing
1170 the function body is associated
1171 with (not necessarily cgraph_node (DECL). */
1172 static cgraph_node *create_alias (tree alias, tree target);
1174 cgraph_edge *callees;
1175 cgraph_edge *callers;
1176 /* List of edges representing indirect calls with a yet undetermined
1177 callee. */
1178 cgraph_edge *indirect_calls;
1179 /* For nested functions points to function the node is nested in. */
1180 cgraph_node *origin;
1181 /* Points to first nested function, if any. */
1182 cgraph_node *nested;
1183 /* Pointer to the next function with same origin, if any. */
1184 cgraph_node *next_nested;
1185 /* Pointer to the next clone. */
1186 cgraph_node *next_sibling_clone;
1187 cgraph_node *prev_sibling_clone;
1188 cgraph_node *clones;
1189 cgraph_node *clone_of;
1190 /* For functions with many calls sites it holds map from call expression
1191 to the edge to speed up cgraph_edge function. */
1192 hash_table<cgraph_edge_hasher> *GTY(()) call_site_hash;
1193 /* Declaration node used to be clone of. */
1194 tree former_clone_of;
1196 /* If this is a SIMD clone, this points to the SIMD specific
1197 information for it. */
1198 cgraph_simd_clone *simdclone;
1199 /* If this function has SIMD clones, this points to the first clone. */
1200 cgraph_node *simd_clones;
1202 /* Interprocedural passes scheduled to have their transform functions
1203 applied next time we execute local pass on them. We maintain it
1204 per-function in order to allow IPA passes to introduce new functions. */
1205 vec<ipa_opt_pass> GTY((skip)) ipa_transforms_to_apply;
1207 cgraph_local_info local;
1208 cgraph_global_info global;
1209 cgraph_rtl_info rtl;
1210 cgraph_clone_info clone;
1211 cgraph_thunk_info thunk;
1213 /* Expected number of executions: calculated in profile.c. */
1214 gcov_type count;
1215 /* How to scale counts at materialization time; used to merge
1216 LTO units with different number of profile runs. */
1217 int count_materialization_scale;
1218 /* Unique id of the node. */
1219 int uid;
1220 /* ID assigned by the profiling. */
1221 unsigned int profile_id;
1222 /* Time profiler: first run of function. */
1223 int tp_first_run;
1225 /* Set when decl is an abstract function pointed to by the
1226 ABSTRACT_DECL_ORIGIN of a reachable function. */
1227 unsigned used_as_abstract_origin : 1;
1228 /* Set once the function is lowered (i.e. its CFG is built). */
1229 unsigned lowered : 1;
1230 /* Set once the function has been instantiated and its callee
1231 lists created. */
1232 unsigned process : 1;
1233 /* How commonly executed the node is. Initialized during branch
1234 probabilities pass. */
1235 ENUM_BITFIELD (node_frequency) frequency : 2;
1236 /* True when function can only be called at startup (from static ctor). */
1237 unsigned only_called_at_startup : 1;
1238 /* True when function can only be called at startup (from static dtor). */
1239 unsigned only_called_at_exit : 1;
1240 /* True when function is the transactional clone of a function which
1241 is called only from inside transactions. */
1242 /* ?? We should be able to remove this. We have enough bits in
1243 cgraph to calculate it. */
1244 unsigned tm_clone : 1;
1245 /* True if this decl is a dispatcher for function versions. */
1246 unsigned dispatcher_function : 1;
1247 /* True if this decl calls a COMDAT-local function. This is set up in
1248 compute_inline_parameters and inline_call. */
1249 unsigned calls_comdat_local : 1;
1250 /* True if node has been created by merge operation in IPA-ICF. */
1251 unsigned icf_merged: 1;
1254 /* A cgraph node set is a collection of cgraph nodes. A cgraph node
1255 can appear in multiple sets. */
1256 struct cgraph_node_set_def
1258 hash_map<cgraph_node *, size_t> *map;
1259 vec<cgraph_node *> nodes;
1262 typedef cgraph_node_set_def *cgraph_node_set;
1263 typedef struct varpool_node_set_def *varpool_node_set;
1265 class varpool_node;
1267 /* A varpool node set is a collection of varpool nodes. A varpool node
1268 can appear in multiple sets. */
1269 struct varpool_node_set_def
1271 hash_map<varpool_node *, size_t> * map;
1272 vec<varpool_node *> nodes;
1275 /* Iterator structure for cgraph node sets. */
1276 struct cgraph_node_set_iterator
1278 cgraph_node_set set;
1279 unsigned index;
1282 /* Iterator structure for varpool node sets. */
1283 struct varpool_node_set_iterator
1285 varpool_node_set set;
1286 unsigned index;
1289 /* Context of polymorphic call. It represent information about the type of
1290 instance that may reach the call. This is used by ipa-devirt walkers of the
1291 type inheritance graph. */
1293 class GTY(()) ipa_polymorphic_call_context {
1294 public:
1295 /* The called object appears in an object of type OUTER_TYPE
1296 at offset OFFSET. When information is not 100% reliable, we
1297 use SPECULATIVE_OUTER_TYPE and SPECULATIVE_OFFSET. */
1298 HOST_WIDE_INT offset;
1299 HOST_WIDE_INT speculative_offset;
1300 tree outer_type;
1301 tree speculative_outer_type;
1302 /* True if outer object may be in construction or destruction. */
1303 unsigned maybe_in_construction : 1;
1304 /* True if outer object may be of derived type. */
1305 unsigned maybe_derived_type : 1;
1306 /* True if speculative outer object may be of derived type. We always
1307 speculate that construction does not happen. */
1308 unsigned speculative_maybe_derived_type : 1;
1309 /* True if the context is invalid and all calls should be redirected
1310 to BUILTIN_UNREACHABLE. */
1311 unsigned invalid : 1;
1312 /* True if the outer type is dynamic. */
1313 unsigned dynamic : 1;
1315 /* Build empty "I know nothing" context. */
1316 ipa_polymorphic_call_context ();
1317 /* Build polymorphic call context for indirect call E. */
1318 ipa_polymorphic_call_context (cgraph_edge *e);
1319 /* Build polymorphic call context for IP invariant CST.
1320 If specified, OTR_TYPE specify the type of polymorphic call
1321 that takes CST+OFFSET as a prameter. */
1322 ipa_polymorphic_call_context (tree cst, tree otr_type = NULL,
1323 HOST_WIDE_INT offset = 0);
1324 /* Build context for pointer REF contained in FNDECL at statement STMT.
1325 if INSTANCE is non-NULL, return pointer to the object described by
1326 the context. */
1327 ipa_polymorphic_call_context (tree fndecl, tree ref, gimple stmt,
1328 tree *instance = NULL);
1330 /* Look for vtable stores or constructor calls to work out dynamic type
1331 of memory location. */
1332 bool get_dynamic_type (tree, tree, tree, gimple);
1334 /* Make context non-speculative. */
1335 void clear_speculation ();
1337 /* Walk container types and modify context to point to actual class
1338 containing OTR_TYPE (if non-NULL) as base class.
1339 Return true if resulting context is valid.
1341 When CONSIDER_PLACEMENT_NEW is false, reject contexts that may be made
1342 valid only via alocation of new polymorphic type inside by means
1343 of placement new.
1345 When CONSIDER_BASES is false, only look for actual fields, not base types
1346 of TYPE. */
1347 bool restrict_to_inner_class (tree otr_type,
1348 bool consider_placement_new = true,
1349 bool consider_bases = true);
1351 /* Adjust all offsets in contexts by given number of bits. */
1352 void offset_by (HOST_WIDE_INT);
1353 /* Use when we can not track dynamic type change. This speculatively assume
1354 type change is not happening. */
1355 void possible_dynamic_type_change (bool, tree otr_type = NULL);
1356 /* Assume that both THIS and a given context is valid and strenghten THIS
1357 if possible. Return true if any strenghtening was made.
1358 If actual type the context is being used in is known, OTR_TYPE should be
1359 set accordingly. This improves quality of combined result. */
1360 bool combine_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1362 /* Return TRUE if context is fully useless. */
1363 bool useless_p () const;
1365 /* Dump human readable context to F. */
1366 void dump (FILE *f) const;
1367 void DEBUG_FUNCTION debug () const;
1369 /* LTO streaming. */
1370 void stream_out (struct output_block *) const;
1371 void stream_in (struct lto_input_block *, struct data_in *data_in);
1373 private:
1374 bool combine_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1375 void set_by_decl (tree, HOST_WIDE_INT);
1376 bool set_by_invariant (tree, tree, HOST_WIDE_INT);
1377 void clear_outer_type (tree otr_type = NULL);
1378 bool speculation_consistent_p (tree, HOST_WIDE_INT, bool, tree);
1379 void make_speculative (tree otr_type = NULL);
1382 /* Structure containing additional information about an indirect call. */
1384 struct GTY(()) cgraph_indirect_call_info
1386 /* When agg_content is set, an offset where the call pointer is located
1387 within the aggregate. */
1388 HOST_WIDE_INT offset;
1389 /* Context of the polymorphic call; use only when POLYMORPHIC flag is set. */
1390 ipa_polymorphic_call_context context;
1391 /* OBJ_TYPE_REF_TOKEN of a polymorphic call (if polymorphic is set). */
1392 HOST_WIDE_INT otr_token;
1393 /* Type of the object from OBJ_TYPE_REF_OBJECT. */
1394 tree otr_type;
1395 /* Index of the parameter that is called. */
1396 int param_index;
1397 /* ECF flags determined from the caller. */
1398 int ecf_flags;
1399 /* Profile_id of common target obtrained from profile. */
1400 int common_target_id;
1401 /* Probability that call will land in function with COMMON_TARGET_ID. */
1402 int common_target_probability;
1404 /* Set when the call is a virtual call with the parameter being the
1405 associated object pointer rather than a simple direct call. */
1406 unsigned polymorphic : 1;
1407 /* Set when the call is a call of a pointer loaded from contents of an
1408 aggregate at offset. */
1409 unsigned agg_contents : 1;
1410 /* Set when this is a call through a member pointer. */
1411 unsigned member_ptr : 1;
1412 /* When the previous bit is set, this one determines whether the destination
1413 is loaded from a parameter passed by reference. */
1414 unsigned by_ref : 1;
1415 /* For polymorphic calls this specify whether the virtual table pointer
1416 may have changed in between function entry and the call. */
1417 unsigned vptr_changed : 1;
1420 struct GTY((chain_next ("%h.next_caller"), chain_prev ("%h.prev_caller"),
1421 for_user)) cgraph_edge {
1422 friend class cgraph_node;
1424 /* Remove the edge in the cgraph. */
1425 void remove (void);
1427 /* Change field call_stmt of edge to NEW_STMT.
1428 If UPDATE_SPECULATIVE and E is any component of speculative
1429 edge, then update all components. */
1430 void set_call_stmt (gimple new_stmt, bool update_speculative = true);
1432 /* Redirect callee of the edge to N. The function does not update underlying
1433 call expression. */
1434 void redirect_callee (cgraph_node *n);
1436 /* Make an indirect edge with an unknown callee an ordinary edge leading to
1437 CALLEE. DELTA is an integer constant that is to be added to the this
1438 pointer (first parameter) to compensate for skipping
1439 a thunk adjustment. */
1440 cgraph_edge *make_direct (cgraph_node *callee);
1442 /* Turn edge into speculative call calling N2. Update
1443 the profile so the direct call is taken COUNT times
1444 with FREQUENCY. */
1445 cgraph_edge *make_speculative (cgraph_node *n2, gcov_type direct_count,
1446 int direct_frequency);
1448 /* Given speculative call edge, return all three components. */
1449 void speculative_call_info (cgraph_edge *&direct, cgraph_edge *&indirect,
1450 ipa_ref *&reference);
1452 /* Speculative call edge turned out to be direct call to CALLE_DECL.
1453 Remove the speculative call sequence and return edge representing the call.
1454 It is up to caller to redirect the call as appropriate. */
1455 cgraph_edge *resolve_speculation (tree callee_decl = NULL);
1457 /* If necessary, change the function declaration in the call statement
1458 associated with the edge so that it corresponds to the edge callee. */
1459 gimple redirect_call_stmt_to_callee (void);
1461 /* Create clone of edge in the node N represented
1462 by CALL_EXPR the callgraph. */
1463 cgraph_edge * clone (cgraph_node *n, gimple call_stmt, unsigned stmt_uid,
1464 gcov_type count_scale, int freq_scale, bool update_original);
1466 /* Return true when call of edge can not lead to return from caller
1467 and thus it is safe to ignore its side effects for IPA analysis
1468 when computing side effects of the caller. */
1469 bool cannot_lead_to_return_p (void);
1471 /* Return true when the edge represents a direct recursion. */
1472 bool recursive_p (void);
1474 /* Return true if the call can be hot. */
1475 bool maybe_hot_p (void);
1477 /* Rebuild cgraph edges for current function node. This needs to be run after
1478 passes that don't update the cgraph. */
1479 static unsigned int rebuild_edges (void);
1481 /* Rebuild cgraph references for current function node. This needs to be run
1482 after passes that don't update the cgraph. */
1483 static void rebuild_references (void);
1485 /* Expected number of executions: calculated in profile.c. */
1486 gcov_type count;
1487 cgraph_node *caller;
1488 cgraph_node *callee;
1489 cgraph_edge *prev_caller;
1490 cgraph_edge *next_caller;
1491 cgraph_edge *prev_callee;
1492 cgraph_edge *next_callee;
1493 gimple call_stmt;
1494 /* Additional information about an indirect call. Not cleared when an edge
1495 becomes direct. */
1496 cgraph_indirect_call_info *indirect_info;
1497 PTR GTY ((skip (""))) aux;
1498 /* When equal to CIF_OK, inline this call. Otherwise, points to the
1499 explanation why function was not inlined. */
1500 enum cgraph_inline_failed_t inline_failed;
1501 /* The stmt_uid of call_stmt. This is used by LTO to recover the call_stmt
1502 when the function is serialized in. */
1503 unsigned int lto_stmt_uid;
1504 /* Expected frequency of executions within the function.
1505 When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
1506 per function call. The range is 0 to CGRAPH_FREQ_MAX. */
1507 int frequency;
1508 /* Unique id of the edge. */
1509 int uid;
1510 /* Whether this edge was made direct by indirect inlining. */
1511 unsigned int indirect_inlining_edge : 1;
1512 /* Whether this edge describes an indirect call with an undetermined
1513 callee. */
1514 unsigned int indirect_unknown_callee : 1;
1515 /* Whether this edge is still a dangling */
1516 /* True if the corresponding CALL stmt cannot be inlined. */
1517 unsigned int call_stmt_cannot_inline_p : 1;
1518 /* Can this call throw externally? */
1519 unsigned int can_throw_external : 1;
1520 /* Edges with SPECULATIVE flag represents indirect calls that was
1521 speculatively turned into direct (i.e. by profile feedback).
1522 The final code sequence will have form:
1524 if (call_target == expected_fn)
1525 expected_fn ();
1526 else
1527 call_target ();
1529 Every speculative call is represented by three components attached
1530 to a same call statement:
1531 1) a direct call (to expected_fn)
1532 2) an indirect call (to call_target)
1533 3) a IPA_REF_ADDR refrence to expected_fn.
1535 Optimizers may later redirect direct call to clone, so 1) and 3)
1536 do not need to necesarily agree with destination. */
1537 unsigned int speculative : 1;
1538 /* Set to true when caller is a constructor or destructor of polymorphic
1539 type. */
1540 unsigned in_polymorphic_cdtor : 1;
1542 private:
1543 /* Remove the edge from the list of the callers of the callee. */
1544 void remove_caller (void);
1546 /* Remove the edge from the list of the callees of the caller. */
1547 void remove_callee (void);
1550 #define CGRAPH_FREQ_BASE 1000
1551 #define CGRAPH_FREQ_MAX 100000
1553 /* The varpool data structure.
1554 Each static variable decl has assigned varpool_node. */
1556 class GTY((tag ("SYMTAB_VARIABLE"))) varpool_node : public symtab_node {
1557 public:
1558 /* Dump given varpool node to F. */
1559 void dump (FILE *f);
1561 /* Dump given varpool node to stderr. */
1562 void DEBUG_FUNCTION debug (void);
1564 /* Remove variable from symbol table. */
1565 void remove (void);
1567 /* Remove node initializer when it is no longer needed. */
1568 void remove_initializer (void);
1570 void analyze (void);
1572 /* Return variable availability. */
1573 availability get_availability (void);
1575 /* When doing LTO, read variable's constructor from disk if
1576 it is not already present. */
1577 tree get_constructor (void);
1579 /* Return true if variable has constructor that can be used for folding. */
1580 bool ctor_useable_for_folding_p (void);
1582 /* For given variable pool node, walk the alias chain to return the function
1583 the variable is alias of. Do not walk through thunks.
1584 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
1585 inline varpool_node *ultimate_alias_target
1586 (availability *availability = NULL);
1588 /* Return node that alias is aliasing. */
1589 inline varpool_node *get_alias_target (void);
1591 /* Output one variable, if necessary. Return whether we output it. */
1592 bool assemble_decl (void);
1594 /* For variables in named sections make sure get_variable_section
1595 is called before we switch to those sections. Then section
1596 conflicts between read-only and read-only requiring relocations
1597 sections can be resolved. */
1598 void finalize_named_section_flags (void);
1600 /* Call calback on varpool symbol and aliases associated to varpool symbol.
1601 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1602 skipped. */
1603 bool call_for_node_and_aliases (bool (*callback) (varpool_node *, void *),
1604 void *data,
1605 bool include_overwritable);
1607 /* Return true when variable should be considered externally visible. */
1608 bool externally_visible_p (void);
1610 /* Return true when all references to variable must be visible
1611 in ipa_ref_list.
1612 i.e. if the variable is not externally visible or not used in some magic
1613 way (asm statement or such).
1614 The magic uses are all summarized in force_output flag. */
1615 inline bool all_refs_explicit_p ();
1617 /* Return true when variable can be removed from variable pool
1618 if all direct calls are eliminated. */
1619 inline bool can_remove_if_no_refs_p (void);
1621 /* Add the variable DECL to the varpool.
1622 Unlike finalize_decl function is intended to be used
1623 by middle end and allows insertion of new variable at arbitrary point
1624 of compilation. */
1625 static void add (tree decl);
1627 /* Return varpool node for given symbol and check it is a function. */
1628 static inline varpool_node *get (const_tree decl);
1630 /* Mark DECL as finalized. By finalizing the declaration, frontend instruct
1631 the middle end to output the variable to asm file, if needed or externally
1632 visible. */
1633 static void finalize_decl (tree decl);
1635 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1636 Extra name aliases are output whenever DECL is output. */
1637 static varpool_node * create_extra_name_alias (tree alias, tree decl);
1639 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1640 Extra name aliases are output whenever DECL is output. */
1641 static varpool_node * create_alias (tree, tree);
1643 /* Dump the variable pool to F. */
1644 static void dump_varpool (FILE *f);
1646 /* Dump the variable pool to stderr. */
1647 static void DEBUG_FUNCTION debug_varpool (void);
1649 /* Allocate new callgraph node and insert it into basic data structures. */
1650 static varpool_node *create_empty (void);
1652 /* Return varpool node assigned to DECL. Create new one when needed. */
1653 static varpool_node *get_create (tree decl);
1655 /* Given an assembler name, lookup node. */
1656 static varpool_node *get_for_asmname (tree asmname);
1658 /* Set when variable is scheduled to be assembled. */
1659 unsigned output : 1;
1661 /* Set if the variable is dynamically initialized, except for
1662 function local statics. */
1663 unsigned dynamically_initialized : 1;
1665 ENUM_BITFIELD(tls_model) tls_model : 3;
1667 /* Set if the variable is known to be used by single function only.
1668 This is computed by ipa_signle_use pass and used by late optimizations
1669 in places where optimization would be valid for local static variable
1670 if we did not do any inter-procedural code movement. */
1671 unsigned used_by_single_function : 1;
1673 private:
1674 /* Assemble thunks and aliases associated to varpool node. */
1675 void assemble_aliases (void);
1678 /* Every top level asm statement is put into a asm_node. */
1680 struct GTY(()) asm_node {
1683 /* Next asm node. */
1684 asm_node *next;
1685 /* String for this asm node. */
1686 tree asm_str;
1687 /* Ordering of all cgraph nodes. */
1688 int order;
1691 /* Report whether or not THIS symtab node is a function, aka cgraph_node. */
1693 template <>
1694 template <>
1695 inline bool
1696 is_a_helper <cgraph_node *>::test (symtab_node *p)
1698 return p && p->type == SYMTAB_FUNCTION;
1701 /* Report whether or not THIS symtab node is a vriable, aka varpool_node. */
1703 template <>
1704 template <>
1705 inline bool
1706 is_a_helper <varpool_node *>::test (symtab_node *p)
1708 return p && p->type == SYMTAB_VARIABLE;
1711 /* Macros to access the next item in the list of free cgraph nodes and
1712 edges. */
1713 #define NEXT_FREE_NODE(NODE) dyn_cast<cgraph_node *> ((NODE)->next)
1714 #define SET_NEXT_FREE_NODE(NODE,NODE2) ((NODE))->next = NODE2
1715 #define NEXT_FREE_EDGE(EDGE) (EDGE)->prev_caller
1717 typedef void (*cgraph_edge_hook)(cgraph_edge *, void *);
1718 typedef void (*cgraph_node_hook)(cgraph_node *, void *);
1719 typedef void (*varpool_node_hook)(varpool_node *, void *);
1720 typedef void (*cgraph_2edge_hook)(cgraph_edge *, cgraph_edge *, void *);
1721 typedef void (*cgraph_2node_hook)(cgraph_node *, cgraph_node *, void *);
1723 struct cgraph_edge_hook_list;
1724 struct cgraph_node_hook_list;
1725 struct varpool_node_hook_list;
1726 struct cgraph_2edge_hook_list;
1727 struct cgraph_2node_hook_list;
1729 /* Map from a symbol to initialization/finalization priorities. */
1730 struct GTY(()) symbol_priority_map {
1731 priority_type init;
1732 priority_type fini;
1735 enum symtab_state
1737 /* Frontend is parsing and finalizing functions. */
1738 PARSING,
1739 /* Callgraph is being constructed. It is safe to add new functions. */
1740 CONSTRUCTION,
1741 /* Callgraph is being at LTO time. */
1742 LTO_STREAMING,
1743 /* Callgraph is built and IPA passes are being run. */
1744 IPA,
1745 /* Callgraph is built and all functions are transformed to SSA form. */
1746 IPA_SSA,
1747 /* Functions are now ordered and being passed to RTL expanders. */
1748 EXPANSION,
1749 /* All cgraph expansion is done. */
1750 FINISHED
1753 struct asmname_hasher
1755 typedef symtab_node *value_type;
1756 typedef const_tree compare_type;
1757 typedef int store_values_directly;
1759 static hashval_t hash (symtab_node *n);
1760 static bool equal (symtab_node *n, const_tree t);
1761 static void ggc_mx (symtab_node *n);
1762 static void pch_nx (symtab_node *&);
1763 static void pch_nx (symtab_node *&, gt_pointer_operator, void *);
1764 static void remove (symtab_node *) {}
1767 class GTY((tag ("SYMTAB"))) symbol_table
1769 public:
1770 friend class symtab_node;
1771 friend class cgraph_node;
1772 friend class cgraph_edge;
1774 /* Initialize callgraph dump file. */
1775 void initialize (void);
1777 /* Register a top-level asm statement ASM_STR. */
1778 inline asm_node *finalize_toplevel_asm (tree asm_str);
1780 /* Analyze the whole compilation unit once it is parsed completely. */
1781 void finalize_compilation_unit (void);
1783 /* C++ frontend produce same body aliases all over the place, even before PCH
1784 gets streamed out. It relies on us linking the aliases with their function
1785 in order to do the fixups, but ipa-ref is not PCH safe. Consequentely we
1786 first produce aliases without links, but once C++ FE is sure he won't sream
1787 PCH we build the links via this function. */
1788 void process_same_body_aliases (void);
1790 /* Perform simple optimizations based on callgraph. */
1791 void compile (void);
1793 /* Process CGRAPH_NEW_FUNCTIONS and perform actions necessary to add these
1794 functions into callgraph in a way so they look like ordinary reachable
1795 functions inserted into callgraph already at construction time. */
1796 void process_new_functions (void);
1798 /* Once all functions from compilation unit are in memory, produce all clones
1799 and update all calls. We might also do this on demand if we don't want to
1800 bring all functions to memory prior compilation, but current WHOPR
1801 implementation does that and it is is bit easier to keep everything right
1802 in this order. */
1803 void materialize_all_clones (void);
1805 /* Register a symbol NODE. */
1806 inline void register_symbol (symtab_node *node);
1808 inline void
1809 clear_asm_symbols (void)
1811 asmnodes = NULL;
1812 asm_last_node = NULL;
1815 /* Perform reachability analysis and reclaim all unreachable nodes. */
1816 bool remove_unreachable_nodes (bool before_inlining_p, FILE *file);
1818 /* Optimization of function bodies might've rendered some variables as
1819 unnecessary so we want to avoid these from being compiled. Re-do
1820 reachability starting from variables that are either externally visible
1821 or was referred from the asm output routines. */
1822 void remove_unreferenced_decls (void);
1824 /* Unregister a symbol NODE. */
1825 inline void unregister (symtab_node *node);
1827 /* Allocate new callgraph node and insert it into basic data structures. */
1828 cgraph_node *create_empty (void);
1830 /* Release a callgraph NODE with UID and put in to the list
1831 of free nodes. */
1832 void release_symbol (cgraph_node *node, int uid);
1834 /* Output all variables enqueued to be assembled. */
1835 bool output_variables (void);
1837 /* Weakrefs may be associated to external decls and thus not output
1838 at expansion time. Emit all necessary aliases. */
1839 void output_weakrefs (void);
1841 /* Return first static symbol with definition. */
1842 inline symtab_node *first_symbol (void);
1844 /* Return first assembler symbol. */
1845 inline asm_node *
1846 first_asm_symbol (void)
1848 return asmnodes;
1851 /* Return first static symbol with definition. */
1852 inline symtab_node *first_defined_symbol (void);
1854 /* Return first variable. */
1855 inline varpool_node *first_variable (void);
1857 /* Return next variable after NODE. */
1858 inline varpool_node *next_variable (varpool_node *node);
1860 /* Return first static variable with initializer. */
1861 inline varpool_node *first_static_initializer (void);
1863 /* Return next static variable with initializer after NODE. */
1864 inline varpool_node *next_static_initializer (varpool_node *node);
1866 /* Return first static variable with definition. */
1867 inline varpool_node *first_defined_variable (void);
1869 /* Return next static variable with definition after NODE. */
1870 inline varpool_node *next_defined_variable (varpool_node *node);
1872 /* Return first function with body defined. */
1873 inline cgraph_node *first_defined_function (void);
1875 /* Return next function with body defined after NODE. */
1876 inline cgraph_node *next_defined_function (cgraph_node *node);
1878 /* Return first function. */
1879 inline cgraph_node *first_function (void);
1881 /* Return next function. */
1882 inline cgraph_node *next_function (cgraph_node *node);
1884 /* Return first function with body defined. */
1885 cgraph_node *first_function_with_gimple_body (void);
1887 /* Return next reachable static variable with initializer after NODE. */
1888 inline cgraph_node *next_function_with_gimple_body (cgraph_node *node);
1890 /* Register HOOK to be called with DATA on each removed edge. */
1891 cgraph_edge_hook_list *add_edge_removal_hook (cgraph_edge_hook hook,
1892 void *data);
1894 /* Remove ENTRY from the list of hooks called on removing edges. */
1895 void remove_edge_removal_hook (cgraph_edge_hook_list *entry);
1897 /* Register HOOK to be called with DATA on each removed node. */
1898 cgraph_node_hook_list *add_cgraph_removal_hook (cgraph_node_hook hook,
1899 void *data);
1901 /* Remove ENTRY from the list of hooks called on removing nodes. */
1902 void remove_cgraph_removal_hook (cgraph_node_hook_list *entry);
1904 /* Register HOOK to be called with DATA on each removed node. */
1905 varpool_node_hook_list *add_varpool_removal_hook (varpool_node_hook hook,
1906 void *data);
1908 /* Remove ENTRY from the list of hooks called on removing nodes. */
1909 void remove_varpool_removal_hook (varpool_node_hook_list *entry);
1911 /* Register HOOK to be called with DATA on each inserted node. */
1912 cgraph_node_hook_list *add_cgraph_insertion_hook (cgraph_node_hook hook,
1913 void *data);
1915 /* Remove ENTRY from the list of hooks called on inserted nodes. */
1916 void remove_cgraph_insertion_hook (cgraph_node_hook_list *entry);
1918 /* Register HOOK to be called with DATA on each inserted node. */
1919 varpool_node_hook_list *add_varpool_insertion_hook (varpool_node_hook hook,
1920 void *data);
1922 /* Remove ENTRY from the list of hooks called on inserted nodes. */
1923 void remove_varpool_insertion_hook (varpool_node_hook_list *entry);
1925 /* Register HOOK to be called with DATA on each duplicated edge. */
1926 cgraph_2edge_hook_list *add_edge_duplication_hook (cgraph_2edge_hook hook,
1927 void *data);
1928 /* Remove ENTRY from the list of hooks called on duplicating edges. */
1929 void remove_edge_duplication_hook (cgraph_2edge_hook_list *entry);
1931 /* Register HOOK to be called with DATA on each duplicated node. */
1932 cgraph_2node_hook_list *add_cgraph_duplication_hook (cgraph_2node_hook hook,
1933 void *data);
1935 /* Remove ENTRY from the list of hooks called on duplicating nodes. */
1936 void remove_cgraph_duplication_hook (cgraph_2node_hook_list *entry);
1938 /* Call all edge removal hooks. */
1939 void call_edge_removal_hooks (cgraph_edge *e);
1941 /* Call all node insertion hooks. */
1942 void call_cgraph_insertion_hooks (cgraph_node *node);
1944 /* Call all node removal hooks. */
1945 void call_cgraph_removal_hooks (cgraph_node *node);
1947 /* Call all node duplication hooks. */
1948 void call_cgraph_duplication_hooks (cgraph_node *node, cgraph_node *node2);
1950 /* Call all edge duplication hooks. */
1951 void call_edge_duplication_hooks (cgraph_edge *cs1, cgraph_edge *cs2);
1953 /* Call all node removal hooks. */
1954 void call_varpool_removal_hooks (varpool_node *node);
1956 /* Call all node insertion hooks. */
1957 void call_varpool_insertion_hooks (varpool_node *node);
1959 /* Arrange node to be first in its entry of assembler_name_hash. */
1960 void symtab_prevail_in_asm_name_hash (symtab_node *node);
1962 /* Initalize asm name hash unless. */
1963 void symtab_initialize_asm_name_hash (void);
1965 /* Set the DECL_ASSEMBLER_NAME and update symtab hashtables. */
1966 void change_decl_assembler_name (tree decl, tree name);
1968 int cgraph_count;
1969 int cgraph_max_uid;
1971 int edges_count;
1972 int edges_max_uid;
1974 symtab_node* GTY(()) nodes;
1975 asm_node* GTY(()) asmnodes;
1976 asm_node* GTY(()) asm_last_node;
1977 cgraph_node* GTY(()) free_nodes;
1979 /* Head of a linked list of unused (freed) call graph edges.
1980 Do not GTY((delete)) this list so UIDs gets reliably recycled. */
1981 cgraph_edge * GTY(()) free_edges;
1983 /* The order index of the next symtab node to be created. This is
1984 used so that we can sort the cgraph nodes in order by when we saw
1985 them, to support -fno-toplevel-reorder. */
1986 int order;
1988 /* Set when whole unit has been analyzed so we can access global info. */
1989 bool global_info_ready;
1990 /* What state callgraph is in right now. */
1991 enum symtab_state state;
1992 /* Set when the cgraph is fully build and the basic flags are computed. */
1993 bool function_flags_ready;
1995 bool cpp_implicit_aliases_done;
1997 /* Hash table used to hold sectoons. */
1998 hash_table<section_name_hasher> *GTY(()) section_hash;
2000 /* Hash table used to convert assembler names into nodes. */
2001 hash_table<asmname_hasher> *assembler_name_hash;
2003 /* Hash table used to hold init priorities. */
2004 hash_map<symtab_node *, symbol_priority_map> *init_priority_hash;
2006 FILE* GTY ((skip)) dump_file;
2008 private:
2009 /* Allocate new callgraph node. */
2010 inline cgraph_node * allocate_cgraph_symbol (void);
2012 /* Allocate a cgraph_edge structure and fill it with data according to the
2013 parameters of which only CALLEE can be NULL (when creating an indirect call
2014 edge). */
2015 cgraph_edge *create_edge (cgraph_node *caller, cgraph_node *callee,
2016 gimple call_stmt, gcov_type count, int freq,
2017 bool indir_unknown_callee);
2019 /* Put the edge onto the free list. */
2020 void free_edge (cgraph_edge *e);
2022 /* Insert NODE to assembler name hash. */
2023 void insert_to_assembler_name_hash (symtab_node *node, bool with_clones);
2025 /* Remove NODE from assembler name hash. */
2026 void unlink_from_assembler_name_hash (symtab_node *node, bool with_clones);
2028 /* Hash asmnames ignoring the user specified marks. */
2029 static hashval_t decl_assembler_name_hash (const_tree asmname);
2031 /* Compare ASMNAME with the DECL_ASSEMBLER_NAME of DECL. */
2032 static bool decl_assembler_name_equal (tree decl, const_tree asmname);
2034 friend struct asmname_hasher;
2036 /* List of hooks triggered when an edge is removed. */
2037 cgraph_edge_hook_list * GTY((skip)) m_first_edge_removal_hook;
2038 /* List of hooks triggem_red when a cgraph node is removed. */
2039 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_removal_hook;
2040 /* List of hooks triggered when an edge is duplicated. */
2041 cgraph_2edge_hook_list * GTY((skip)) m_first_edge_duplicated_hook;
2042 /* List of hooks triggered when a node is duplicated. */
2043 cgraph_2node_hook_list * GTY((skip)) m_first_cgraph_duplicated_hook;
2044 /* List of hooks triggered when an function is inserted. */
2045 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_insertion_hook;
2046 /* List of hooks triggered when an variable is inserted. */
2047 varpool_node_hook_list * GTY((skip)) m_first_varpool_insertion_hook;
2048 /* List of hooks triggered when a node is removed. */
2049 varpool_node_hook_list * GTY((skip)) m_first_varpool_removal_hook;
2052 extern GTY(()) symbol_table *symtab;
2054 extern vec<cgraph_node *> cgraph_new_nodes;
2056 inline hashval_t
2057 asmname_hasher::hash (symtab_node *n)
2059 return symbol_table::decl_assembler_name_hash
2060 (DECL_ASSEMBLER_NAME (n->decl));
2063 inline bool
2064 asmname_hasher::equal (symtab_node *n, const_tree t)
2066 return symbol_table::decl_assembler_name_equal (n->decl, t);
2069 extern void gt_ggc_mx (symtab_node *&);
2071 inline void
2072 asmname_hasher::ggc_mx (symtab_node *n)
2074 gt_ggc_mx (n);
2077 extern void gt_pch_nx (symtab_node *&);
2079 inline void
2080 asmname_hasher::pch_nx (symtab_node *&n)
2082 gt_pch_nx (n);
2085 inline void
2086 asmname_hasher::pch_nx (symtab_node *&n, gt_pointer_operator op, void *cookie)
2088 op (&n, cookie);
2091 /* In cgraph.c */
2092 void cgraph_c_finalize (void);
2093 void release_function_body (tree);
2094 cgraph_indirect_call_info *cgraph_allocate_init_indirect_info (void);
2096 void cgraph_update_edges_for_call_stmt (gimple, tree, gimple);
2097 bool cgraph_function_possibly_inlined_p (tree);
2099 const char* cgraph_inline_failed_string (cgraph_inline_failed_t);
2100 cgraph_inline_failed_type_t cgraph_inline_failed_type (cgraph_inline_failed_t);
2102 bool resolution_used_from_other_file_p (enum ld_plugin_symbol_resolution);
2103 extern bool gimple_check_call_matching_types (gimple, tree, bool);
2105 /* In cgraphunit.c */
2106 void cgraphunit_c_finalize (void);
2108 /* Initialize datastructures so DECL is a function in lowered gimple form.
2109 IN_SSA is true if the gimple is in SSA. */
2110 basic_block init_lowered_empty_function (tree, bool);
2112 /* In cgraphclones.c */
2114 tree clone_function_name (tree decl, const char *);
2116 void tree_function_versioning (tree, tree, vec<ipa_replace_map *, va_gc> *,
2117 bool, bitmap, bool, bitmap, basic_block);
2119 /* In cgraphbuild.c */
2120 int compute_call_stmt_bb_frequency (tree, basic_block bb);
2121 void record_references_in_initializer (tree, bool);
2123 /* In ipa.c */
2124 void cgraph_build_static_cdtor (char which, tree body, int priority);
2125 void ipa_discover_readonly_nonaddressable_vars (void);
2127 /* In varpool.c */
2128 tree ctor_for_folding (tree);
2130 /* Return true when the symbol is real symbol, i.e. it is not inline clone
2131 or abstract function kept for debug info purposes only. */
2132 inline bool
2133 symtab_node::real_symbol_p (void)
2135 cgraph_node *cnode;
2137 if (DECL_ABSTRACT_P (decl))
2138 return false;
2139 if (!is_a <cgraph_node *> (this))
2140 return true;
2141 cnode = dyn_cast <cgraph_node *> (this);
2142 if (cnode->global.inlined_to)
2143 return false;
2144 return true;
2147 /* Return true if DECL should have entry in symbol table if used.
2148 Those are functions and static & external veriables*/
2150 static inline bool
2151 decl_in_symtab_p (const_tree decl)
2153 return (TREE_CODE (decl) == FUNCTION_DECL
2154 || (TREE_CODE (decl) == VAR_DECL
2155 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl))));
2158 inline bool
2159 symtab_node::in_same_comdat_group_p (symtab_node *target)
2161 symtab_node *source = this;
2163 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2165 if (cn->global.inlined_to)
2166 source = cn->global.inlined_to;
2168 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2170 if (cn->global.inlined_to)
2171 target = cn->global.inlined_to;
2174 return source->get_comdat_group () == target->get_comdat_group ();
2177 /* Return node that alias is aliasing. */
2179 inline symtab_node *
2180 symtab_node::get_alias_target (void)
2182 ipa_ref *ref = NULL;
2183 iterate_reference (0, ref);
2184 gcc_checking_assert (ref->use == IPA_REF_ALIAS);
2185 return ref->referred;
2188 /* Return next reachable static symbol with initializer after the node. */
2189 inline symtab_node *
2190 symtab_node::next_defined_symbol (void)
2192 symtab_node *node1 = next;
2194 for (; node1; node1 = node1->next)
2195 if (node1->definition)
2196 return node1;
2198 return NULL;
2201 /* Return varpool node for given symbol and check it is a function. */
2203 inline varpool_node *
2204 varpool_node::get (const_tree decl)
2206 gcc_checking_assert (TREE_CODE (decl) == VAR_DECL);
2207 return dyn_cast<varpool_node *> (symtab_node::get (decl));
2210 /* Register a symbol NODE. */
2212 inline void
2213 symbol_table::register_symbol (symtab_node *node)
2215 node->next = nodes;
2216 node->previous = NULL;
2218 if (nodes)
2219 nodes->previous = node;
2220 nodes = node;
2222 node->order = order++;
2225 /* Register a top-level asm statement ASM_STR. */
2227 asm_node *
2228 symbol_table::finalize_toplevel_asm (tree asm_str)
2230 asm_node *node;
2232 node = ggc_cleared_alloc<asm_node> ();
2233 node->asm_str = asm_str;
2234 node->order = order++;
2235 node->next = NULL;
2237 if (asmnodes == NULL)
2238 asmnodes = node;
2239 else
2240 asm_last_node->next = node;
2242 asm_last_node = node;
2243 return node;
2246 /* Unregister a symbol NODE. */
2247 inline void
2248 symbol_table::unregister (symtab_node *node)
2250 if (node->previous)
2251 node->previous->next = node->next;
2252 else
2253 nodes = node->next;
2255 if (node->next)
2256 node->next->previous = node->previous;
2258 node->next = NULL;
2259 node->previous = NULL;
2262 /* Release a callgraph NODE with UID and put in to the list of free nodes. */
2264 inline void
2265 symbol_table::release_symbol (cgraph_node *node, int uid)
2267 cgraph_count--;
2269 /* Clear out the node to NULL all pointers and add the node to the free
2270 list. */
2271 memset (node, 0, sizeof (*node));
2272 node->type = SYMTAB_FUNCTION;
2273 node->uid = uid;
2274 SET_NEXT_FREE_NODE (node, free_nodes);
2275 free_nodes = node;
2278 /* Allocate new callgraph node. */
2280 inline cgraph_node *
2281 symbol_table::allocate_cgraph_symbol (void)
2283 cgraph_node *node;
2285 if (free_nodes)
2287 node = free_nodes;
2288 free_nodes = NEXT_FREE_NODE (node);
2290 else
2292 node = ggc_cleared_alloc<cgraph_node> ();
2293 node->uid = cgraph_max_uid++;
2296 return node;
2300 /* Return first static symbol with definition. */
2301 inline symtab_node *
2302 symbol_table::first_symbol (void)
2304 return nodes;
2307 /* Walk all symbols. */
2308 #define FOR_EACH_SYMBOL(node) \
2309 for ((node) = symtab->first_symbol (); (node); (node) = (node)->next)
2311 /* Return first static symbol with definition. */
2312 inline symtab_node *
2313 symbol_table::first_defined_symbol (void)
2315 symtab_node *node;
2317 for (node = nodes; node; node = node->next)
2318 if (node->definition)
2319 return node;
2321 return NULL;
2324 /* Walk all symbols with definitions in current unit. */
2325 #define FOR_EACH_DEFINED_SYMBOL(node) \
2326 for ((node) = symtab->first_defined_symbol (); (node); \
2327 (node) = node->next_defined_symbol ())
2329 /* Return first variable. */
2330 inline varpool_node *
2331 symbol_table::first_variable (void)
2333 symtab_node *node;
2334 for (node = nodes; node; node = node->next)
2335 if (varpool_node *vnode = dyn_cast <varpool_node *> (node))
2336 return vnode;
2337 return NULL;
2340 /* Return next variable after NODE. */
2341 inline varpool_node *
2342 symbol_table::next_variable (varpool_node *node)
2344 symtab_node *node1 = node->next;
2345 for (; node1; node1 = node1->next)
2346 if (varpool_node *vnode1 = dyn_cast <varpool_node *> (node1))
2347 return vnode1;
2348 return NULL;
2350 /* Walk all variables. */
2351 #define FOR_EACH_VARIABLE(node) \
2352 for ((node) = symtab->first_variable (); \
2353 (node); \
2354 (node) = symtab->next_variable ((node)))
2356 /* Return first static variable with initializer. */
2357 inline varpool_node *
2358 symbol_table::first_static_initializer (void)
2360 symtab_node *node;
2361 for (node = nodes; node; node = node->next)
2363 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2364 if (vnode && DECL_INITIAL (node->decl))
2365 return vnode;
2367 return NULL;
2370 /* Return next static variable with initializer after NODE. */
2371 inline varpool_node *
2372 symbol_table::next_static_initializer (varpool_node *node)
2374 symtab_node *node1 = node->next;
2375 for (; node1; node1 = node1->next)
2377 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2378 if (vnode1 && DECL_INITIAL (node1->decl))
2379 return vnode1;
2381 return NULL;
2384 /* Walk all static variables with initializer set. */
2385 #define FOR_EACH_STATIC_INITIALIZER(node) \
2386 for ((node) = symtab->first_static_initializer (); (node); \
2387 (node) = symtab->next_static_initializer (node))
2389 /* Return first static variable with definition. */
2390 inline varpool_node *
2391 symbol_table::first_defined_variable (void)
2393 symtab_node *node;
2394 for (node = nodes; node; node = node->next)
2396 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2397 if (vnode && vnode->definition)
2398 return vnode;
2400 return NULL;
2403 /* Return next static variable with definition after NODE. */
2404 inline varpool_node *
2405 symbol_table::next_defined_variable (varpool_node *node)
2407 symtab_node *node1 = node->next;
2408 for (; node1; node1 = node1->next)
2410 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2411 if (vnode1 && vnode1->definition)
2412 return vnode1;
2414 return NULL;
2416 /* Walk all variables with definitions in current unit. */
2417 #define FOR_EACH_DEFINED_VARIABLE(node) \
2418 for ((node) = symtab->first_defined_variable (); (node); \
2419 (node) = symtab->next_defined_variable (node))
2421 /* Return first function with body defined. */
2422 inline cgraph_node *
2423 symbol_table::first_defined_function (void)
2425 symtab_node *node;
2426 for (node = nodes; node; node = node->next)
2428 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2429 if (cn && cn->definition)
2430 return cn;
2432 return NULL;
2435 /* Return next function with body defined after NODE. */
2436 inline cgraph_node *
2437 symbol_table::next_defined_function (cgraph_node *node)
2439 symtab_node *node1 = node->next;
2440 for (; node1; node1 = node1->next)
2442 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2443 if (cn1 && cn1->definition)
2444 return cn1;
2446 return NULL;
2449 /* Walk all functions with body defined. */
2450 #define FOR_EACH_DEFINED_FUNCTION(node) \
2451 for ((node) = symtab->first_defined_function (); (node); \
2452 (node) = symtab->next_defined_function ((node)))
2454 /* Return first function. */
2455 inline cgraph_node *
2456 symbol_table::first_function (void)
2458 symtab_node *node;
2459 for (node = nodes; node; node = node->next)
2460 if (cgraph_node *cn = dyn_cast <cgraph_node *> (node))
2461 return cn;
2462 return NULL;
2465 /* Return next function. */
2466 inline cgraph_node *
2467 symbol_table::next_function (cgraph_node *node)
2469 symtab_node *node1 = node->next;
2470 for (; node1; node1 = node1->next)
2471 if (cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1))
2472 return cn1;
2473 return NULL;
2476 /* Return first function with body defined. */
2477 inline cgraph_node *
2478 symbol_table::first_function_with_gimple_body (void)
2480 symtab_node *node;
2481 for (node = nodes; node; node = node->next)
2483 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2484 if (cn && cn->has_gimple_body_p ())
2485 return cn;
2487 return NULL;
2490 /* Return next reachable static variable with initializer after NODE. */
2491 inline cgraph_node *
2492 symbol_table::next_function_with_gimple_body (cgraph_node *node)
2494 symtab_node *node1 = node->next;
2495 for (; node1; node1 = node1->next)
2497 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2498 if (cn1 && cn1->has_gimple_body_p ())
2499 return cn1;
2501 return NULL;
2504 /* Walk all functions. */
2505 #define FOR_EACH_FUNCTION(node) \
2506 for ((node) = symtab->first_function (); (node); \
2507 (node) = symtab->next_function ((node)))
2509 /* Return true when callgraph node is a function with Gimple body defined
2510 in current unit. Functions can also be define externally or they
2511 can be thunks with no Gimple representation.
2513 Note that at WPA stage, the function body may not be present in memory. */
2515 inline bool
2516 cgraph_node::has_gimple_body_p (void)
2518 return definition && !thunk.thunk_p && !alias;
2521 /* Walk all functions with body defined. */
2522 #define FOR_EACH_FUNCTION_WITH_GIMPLE_BODY(node) \
2523 for ((node) = symtab->first_function_with_gimple_body (); (node); \
2524 (node) = symtab->next_function_with_gimple_body (node))
2526 /* Create a new static variable of type TYPE. */
2527 tree add_new_static_var (tree type);
2529 /* Uniquize all constants that appear in memory.
2530 Each constant in memory thus far output is recorded
2531 in `const_desc_table'. */
2533 struct GTY((for_user)) constant_descriptor_tree {
2534 /* A MEM for the constant. */
2535 rtx rtl;
2537 /* The value of the constant. */
2538 tree value;
2540 /* Hash of value. Computing the hash from value each time
2541 hashfn is called can't work properly, as that means recursive
2542 use of the hash table during hash table expansion. */
2543 hashval_t hash;
2546 /* Return true when function is only called directly or it has alias.
2547 i.e. it is not externally visible, address was not taken and
2548 it is not used in any other non-standard way. */
2550 inline bool
2551 cgraph_node::only_called_directly_or_aliased_p (void)
2553 gcc_assert (!global.inlined_to);
2554 return (!force_output && !address_taken
2555 && !used_from_other_partition
2556 && !DECL_VIRTUAL_P (decl)
2557 && !DECL_STATIC_CONSTRUCTOR (decl)
2558 && !DECL_STATIC_DESTRUCTOR (decl)
2559 && !externally_visible);
2562 /* Return true when variable can be removed from variable pool
2563 if all direct calls are eliminated. */
2565 inline bool
2566 varpool_node::can_remove_if_no_refs_p (void)
2568 if (DECL_EXTERNAL (decl))
2569 return true;
2570 return (!force_output && !used_from_other_partition
2571 && ((DECL_COMDAT (decl)
2572 && !forced_by_abi
2573 && !used_from_object_file_p ())
2574 || !externally_visible
2575 || DECL_HAS_VALUE_EXPR_P (decl)));
2578 /* Return true when all references to variable must be visible in ipa_ref_list.
2579 i.e. if the variable is not externally visible or not used in some magic
2580 way (asm statement or such).
2581 The magic uses are all summarized in force_output flag. */
2583 inline bool
2584 varpool_node::all_refs_explicit_p ()
2586 return (definition
2587 && !externally_visible
2588 && !used_from_other_partition
2589 && !force_output);
2592 struct tree_descriptor_hasher : ggc_hasher<constant_descriptor_tree *>
2594 static hashval_t hash (constant_descriptor_tree *);
2595 static bool equal (constant_descriptor_tree *, constant_descriptor_tree *);
2598 /* Constant pool accessor function. */
2599 hash_table<tree_descriptor_hasher> *constant_pool_htab (void);
2601 /* Return node that alias is aliasing. */
2603 inline cgraph_node *
2604 cgraph_node::get_alias_target (void)
2606 return dyn_cast <cgraph_node *> (symtab_node::get_alias_target ());
2609 /* Return node that alias is aliasing. */
2611 inline varpool_node *
2612 varpool_node::get_alias_target (void)
2614 return dyn_cast <varpool_node *> (symtab_node::get_alias_target ());
2617 /* Given function symbol, walk the alias chain to return the function node
2618 is alias of. Do not walk through thunks.
2619 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2621 inline cgraph_node *
2622 cgraph_node::ultimate_alias_target (enum availability *availability)
2624 cgraph_node *n = dyn_cast <cgraph_node *> (symtab_node::ultimate_alias_target
2625 (availability));
2626 if (!n && availability)
2627 *availability = AVAIL_NOT_AVAILABLE;
2628 return n;
2631 /* For given variable pool node, walk the alias chain to return the function
2632 the variable is alias of. Do not walk through thunks.
2633 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2635 inline varpool_node *
2636 varpool_node::ultimate_alias_target (availability *availability)
2638 varpool_node *n = dyn_cast <varpool_node *>
2639 (symtab_node::ultimate_alias_target (availability));
2641 if (!n && availability)
2642 *availability = AVAIL_NOT_AVAILABLE;
2643 return n;
2646 /* Return true when the edge represents a direct recursion. */
2647 inline bool
2648 cgraph_edge::recursive_p (void)
2650 cgraph_node *c = callee->ultimate_alias_target ();
2651 if (caller->global.inlined_to)
2652 return caller->global.inlined_to->decl == c->decl;
2653 else
2654 return caller->decl == c->decl;
2657 /* Return true if the TM_CLONE bit is set for a given FNDECL. */
2658 static inline bool
2659 decl_is_tm_clone (const_tree fndecl)
2661 cgraph_node *n = cgraph_node::get (fndecl);
2662 if (n)
2663 return n->tm_clone;
2664 return false;
2667 /* Likewise indicate that a node is needed, i.e. reachable via some
2668 external means. */
2670 inline void
2671 cgraph_node::mark_force_output (void)
2673 force_output = 1;
2674 gcc_checking_assert (!global.inlined_to);
2677 /* Return true if function should be optimized for size. */
2679 inline bool
2680 cgraph_node::optimize_for_size_p (void)
2682 if (optimize_size)
2683 return true;
2684 if (frequency == NODE_FREQUENCY_UNLIKELY_EXECUTED)
2685 return true;
2686 else
2687 return false;
2690 inline symtab_node * symtab_node::get_create (tree node)
2692 if (TREE_CODE (node) == VAR_DECL)
2693 return varpool_node::get_create (node);
2694 else
2695 return cgraph_node::get_create (node);
2698 /* Build polymorphic call context for indirect call E. */
2700 inline
2701 ipa_polymorphic_call_context::ipa_polymorphic_call_context (cgraph_edge *e)
2703 gcc_checking_assert (e->indirect_info->polymorphic);
2704 *this = e->indirect_info->context;
2707 /* Build empty "I know nothing" context. */
2709 inline
2710 ipa_polymorphic_call_context::ipa_polymorphic_call_context ()
2712 clear_speculation ();
2713 clear_outer_type ();
2714 invalid = false;
2717 /* Make context non-speculative. */
2719 inline void
2720 ipa_polymorphic_call_context::clear_speculation ()
2722 speculative_outer_type = NULL;
2723 speculative_offset = 0;
2724 speculative_maybe_derived_type = false;
2727 /* Produce context specifying all derrived types of OTR_TYPE.
2728 If OTR_TYPE is NULL or type of the OBJ_TYPE_REF, the context is set
2729 to dummy "I know nothing" setting. */
2731 inline void
2732 ipa_polymorphic_call_context::clear_outer_type (tree otr_type)
2734 outer_type = otr_type ? TYPE_MAIN_VARIANT (otr_type) : NULL;
2735 offset = 0;
2736 maybe_derived_type = true;
2737 maybe_in_construction = true;
2738 dynamic = true;
2741 /* Adjust all offsets in contexts by OFF bits. */
2743 inline void
2744 ipa_polymorphic_call_context::offset_by (HOST_WIDE_INT off)
2746 if (outer_type)
2747 offset += off;
2748 if (speculative_outer_type)
2749 speculative_offset += off;
2752 /* Return TRUE if context is fully useless. */
2754 inline bool
2755 ipa_polymorphic_call_context::useless_p () const
2757 return (!outer_type && !speculative_outer_type);
2759 #endif /* GCC_CGRAPH_H */