]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/cgraph.h
cp-tree.h (OVL_P): New.
[thirdparty/gcc.git] / gcc / cgraph.h
CommitLineData
1c4a429a 1/* Callgraph handling code.
cbe34bb5 2 Copyright (C) 2003-2017 Free Software Foundation, Inc.
1c4a429a
JH
3 Contributed by Jan Hubicka
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify it under
8the terms of the GNU General Public License as published by the Free
9dcd6f09 9Software Foundation; either version 3, or (at your option) any later
1c4a429a
JH
10version.
11
12GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13WARRANTY; without even the implied warranty of MERCHANTABILITY or
14FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15for more details.
16
17You should have received a copy of the GNU General Public License
9dcd6f09
NC
18along with GCC; see the file COPYING3. If not see
19<http://www.gnu.org/licenses/>. */
1c4a429a
JH
20
21#ifndef GCC_CGRAPH_H
22#define GCC_CGRAPH_H
7a8cba34 23
f0889939
AM
24#include "ipa-ref.h"
25#include "plugin-api.h"
26
27class ipa_opt_pass_d;
28typedef ipa_opt_pass_d *ipa_opt_pass;
1f00098b
JH
29
30/* Symbol table consists of functions and variables.
e70670cf 31 TODO: add labels and CONST_DECLs. */
1f00098b
JH
32enum symtab_type
33{
960bfb69 34 SYMTAB_SYMBOL,
1f00098b
JH
35 SYMTAB_FUNCTION,
36 SYMTAB_VARIABLE
37};
38
f961457f
JH
39/* Section names are stored as reference counted strings in GGC safe hashtable
40 (to make them survive through PCH). */
41
50686850 42struct GTY((for_user)) section_hash_entry
f961457f
JH
43{
44 int ref_count;
45 char *name; /* As long as this datastructure stays in GGC, we can not put
46 string at the tail of structure of GGC dies in horrible
47 way */
48};
49
ca752f39 50struct section_name_hasher : ggc_ptr_hash<section_hash_entry>
2a22f99c
TS
51{
52 typedef const char *compare_type;
53
54 static hashval_t hash (section_hash_entry *);
55 static bool equal (section_hash_entry *, const char *);
56};
57
d52f5295
ML
58enum availability
59{
60 /* Not yet set by cgraph_function_body_availability. */
61 AVAIL_UNSET,
62 /* Function body/variable initializer is unknown. */
63 AVAIL_NOT_AVAILABLE,
64 /* Function body/variable initializer is known but might be replaced
65 by a different one from other compilation unit and thus needs to
66 be dealt with a care. Like AVAIL_NOT_AVAILABLE it can have
67 arbitrary side effects on escaping variables and functions, while
68 like AVAILABLE it might access static variables. */
69 AVAIL_INTERPOSABLE,
70 /* Function body/variable initializer is known and will be used in final
71 program. */
72 AVAIL_AVAILABLE,
73 /* Function body/variable initializer is known and all it's uses are
74 explicitly visible within current unit (ie it's address is never taken and
75 it is not exported to other units). Currently used only for functions. */
76 AVAIL_LOCAL
77};
78
79/* Classification of symbols WRT partitioning. */
80enum symbol_partitioning_class
81{
82 /* External declarations are ignored by partitioning algorithms and they are
83 added into the boundary later via compute_ltrans_boundary. */
84 SYMBOL_EXTERNAL,
85 /* Partitioned symbols are pur into one of partitions. */
86 SYMBOL_PARTITION,
87 /* Duplicated symbols (such as comdat or constant pool references) are
88 copied into every node needing them via add_symbol_to_partition. */
89 SYMBOL_DUPLICATE
90};
91
1f00098b
JH
92/* Base of all entries in the symbol table.
93 The symtab_node is inherited by cgraph and varpol nodes. */
a3bfa8b8
DM
94class GTY((desc ("%h.type"), tag ("SYMTAB_SYMBOL"),
95 chain_next ("%h.next"), chain_prev ("%h.previous")))
5e20cdc9 96 symtab_node
1f00098b 97{
a3bfa8b8 98public:
fec39fa6
TS
99 /* Return name. */
100 const char *name () const;
101
102 /* Return asm name. */
103 const char * asm_name () const;
104
d52f5295
ML
105 /* Add node into symbol table. This function is not used directly, but via
106 cgraph/varpool node creation routines. */
107 void register_symbol (void);
108
109 /* Remove symbol from symbol table. */
110 void remove (void);
111
112 /* Dump symtab node to F. */
113 void dump (FILE *f);
114
115 /* Dump symtab node to stderr. */
116 void DEBUG_FUNCTION debug (void);
117
118 /* Verify consistency of node. */
119 void DEBUG_FUNCTION verify (void);
120
121 /* Return ipa reference from this symtab_node to
122 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
123 of the use and STMT the statement (if it exists). */
3dafb85c
ML
124 ipa_ref *create_reference (symtab_node *referred_node,
125 enum ipa_ref_use use_type);
d52f5295
ML
126
127 /* Return ipa reference from this symtab_node to
128 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
129 of the use and STMT the statement (if it exists). */
3dafb85c 130 ipa_ref *create_reference (symtab_node *referred_node,
355fe088 131 enum ipa_ref_use use_type, gimple *stmt);
d52f5295
ML
132
133 /* If VAL is a reference to a function or a variable, add a reference from
2d8d3ae2 134 this symtab_node to the corresponding symbol table node. Return the new
d52f5295 135 reference or NULL if none was created. */
2d8d3ae2 136 ipa_ref *maybe_create_reference (tree val, gimple *stmt);
d52f5295
ML
137
138 /* Clone all references from symtab NODE to this symtab_node. */
139 void clone_references (symtab_node *node);
140
141 /* Remove all stmt references in non-speculative references.
142 Those are not maintained during inlining & clonning.
143 The exception are speculative references that are updated along
144 with callgraph edges associated with them. */
145 void clone_referring (symtab_node *node);
146
147 /* Clone reference REF to this symtab_node and set its stmt to STMT. */
355fe088 148 ipa_ref *clone_reference (ipa_ref *ref, gimple *stmt);
d52f5295
ML
149
150 /* Find the structure describing a reference to REFERRED_NODE
151 and associated with statement STMT. */
355fe088 152 ipa_ref *find_reference (symtab_node *referred_node, gimple *stmt,
3dafb85c 153 unsigned int lto_stmt_uid);
d52f5295
ML
154
155 /* Remove all references that are associated with statement STMT. */
355fe088 156 void remove_stmt_references (gimple *stmt);
d52f5295
ML
157
158 /* Remove all stmt references in non-speculative references.
159 Those are not maintained during inlining & clonning.
160 The exception are speculative references that are updated along
161 with callgraph edges associated with them. */
162 void clear_stmts_in_references (void);
163
164 /* Remove all references in ref list. */
165 void remove_all_references (void);
166
167 /* Remove all referring items in ref list. */
168 void remove_all_referring (void);
169
170 /* Dump references in ref list to FILE. */
171 void dump_references (FILE *file);
172
173 /* Dump referring in list to FILE. */
174 void dump_referring (FILE *);
175
b84d4347
ML
176 /* Get number of references for this node. */
177 inline unsigned num_references (void)
178 {
179 return ref_list.references ? ref_list.references->length () : 0;
180 }
181
d52f5295 182 /* Iterates I-th reference in the list, REF is also set. */
3dafb85c 183 ipa_ref *iterate_reference (unsigned i, ipa_ref *&ref);
d52f5295
ML
184
185 /* Iterates I-th referring item in the list, REF is also set. */
3dafb85c 186 ipa_ref *iterate_referring (unsigned i, ipa_ref *&ref);
d52f5295
ML
187
188 /* Iterates I-th referring alias item in the list, REF is also set. */
3dafb85c 189 ipa_ref *iterate_direct_aliases (unsigned i, ipa_ref *&ref);
d52f5295
ML
190
191 /* Return true if symtab node and TARGET represents
192 semantically equivalent symbols. */
193 bool semantically_equivalent_p (symtab_node *target);
194
195 /* Classify symbol symtab node for partitioning. */
196 enum symbol_partitioning_class get_partitioning_class (void);
197
198 /* Return comdat group. */
199 tree get_comdat_group ()
200 {
201 return x_comdat_group;
202 }
203
204 /* Return comdat group as identifier_node. */
205 tree get_comdat_group_id ()
206 {
207 if (x_comdat_group && TREE_CODE (x_comdat_group) != IDENTIFIER_NODE)
208 x_comdat_group = DECL_ASSEMBLER_NAME (x_comdat_group);
209 return x_comdat_group;
210 }
211
212 /* Set comdat group. */
213 void set_comdat_group (tree group)
214 {
215 gcc_checking_assert (!group || TREE_CODE (group) == IDENTIFIER_NODE
216 || DECL_P (group));
217 x_comdat_group = group;
218 }
219
220 /* Return section as string. */
221 const char * get_section ()
222 {
223 if (!x_section)
224 return NULL;
225 return x_section->name;
226 }
227
228 /* Remove node from same comdat group. */
229 void remove_from_same_comdat_group (void);
230
231 /* Add this symtab_node to the same comdat group that OLD is in. */
232 void add_to_same_comdat_group (symtab_node *old_node);
233
234 /* Dissolve the same_comdat_group list in which NODE resides. */
235 void dissolve_same_comdat_group_list (void);
236
237 /* Return true when symtab_node is known to be used from other (non-LTO)
238 object file. Known only when doing LTO via linker plugin. */
239 bool used_from_object_file_p (void);
240
241 /* Walk the alias chain to return the symbol NODE is alias of.
242 If NODE is not an alias, return NODE.
f13fe18b
JH
243 When AVAILABILITY is non-NULL, get minimal availability in the chain.
244 When REF is non-NULL, assume that reference happens in symbol REF
245 when determining the availability. */
246 symtab_node *ultimate_alias_target (enum availability *avail = NULL,
247 struct symtab_node *ref = NULL);
d52f5295
ML
248
249 /* Return next reachable static symbol with initializer after NODE. */
250 inline symtab_node *next_defined_symbol (void);
251
252 /* Add reference recording that symtab node is alias of TARGET.
71e54687 253 If TRANSPARENT is true make the alias to be transparent alias.
d52f5295
ML
254 The function can fail in the case of aliasing cycles; in this case
255 it returns false. */
71e54687 256 bool resolve_alias (symtab_node *target, bool transparent = false);
d52f5295
ML
257
258 /* C++ FE sometimes change linkage flags after producing same
259 body aliases. */
260 void fixup_same_cpp_alias_visibility (symtab_node *target);
261
6cbde2e3 262 /* Call callback on symtab node and aliases associated to this node.
d52f5295 263 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
6cbde2e3 264 skipped. */
d52f5295 265 bool call_for_symbol_and_aliases (bool (*callback) (symtab_node *, void *),
a6a543bf
JH
266 void *data,
267 bool include_overwrite);
d52f5295
ML
268
269 /* If node can not be interposable by static or dynamic linker to point to
270 different definition, return this symbol. Otherwise look for alias with
271 such property and if none exists, introduce new one. */
272 symtab_node *noninterposable_alias (void);
273
274 /* Return node that alias is aliasing. */
275 inline symtab_node *get_alias_target (void);
276
277 /* Set section for symbol and its aliases. */
278 void set_section (const char *section);
279
280 /* Set section, do not recurse into aliases.
281 When one wants to change section of symbol and its aliases,
282 use set_section. */
283 void set_section_for_node (const char *section);
284
285 /* Set initialization priority to PRIORITY. */
286 void set_init_priority (priority_type priority);
287
288 /* Return the initialization priority. */
289 priority_type get_init_priority ();
290
f13fe18b
JH
291 /* Return availability of NODE when referenced from REF. */
292 enum availability get_availability (symtab_node *ref = NULL);
293
294 /* Return true if NODE binds to current definition in final executable
295 when referenced from REF. If REF is NULL return conservative value
296 for any reference. */
297 bool binds_to_current_def_p (symtab_node *ref = NULL);
d52f5295
ML
298
299 /* Make DECL local. */
300 void make_decl_local (void);
301
ed2a53e7
JH
302 /* Copy visibility from N. */
303 void copy_visibility_from (symtab_node *n);
304
428f0c67
JH
305 /* Return desired alignment of the definition. This is NOT alignment useful
306 to access THIS, because THIS may be interposable and DECL_ALIGN should
307 be used instead. It however must be guaranteed when output definition
308 of THIS. */
309 unsigned int definition_alignment ();
310
311 /* Return true if alignment can be increased. */
312 bool can_increase_alignment_p ();
313
314 /* Increase alignment of symbol to ALIGN. */
315 void increase_alignment (unsigned int align);
316
d52f5295
ML
317 /* Return true if list contains an alias. */
318 bool has_aliases_p (void);
319
320 /* Return true when the symbol is real symbol, i.e. it is not inline clone
321 or abstract function kept for debug info purposes only. */
322 bool real_symbol_p (void);
323
3dafb85c
ML
324 /* Determine if symbol declaration is needed. That is, visible to something
325 either outside this translation unit, something magic in the system
326 configury. This function is used just during symbol creation. */
327 bool needed_p (void);
328
c2e84327
DM
329 /* Return true if this symbol is a function from the C frontend specified
330 directly in RTL form (with "__RTL"). */
331 bool native_rtl_p () const;
332
3dafb85c 333 /* Return true when there are references to the node. */
d7438551 334 bool referred_to_p (bool include_self = true);
3dafb85c 335
f1703a2e
JH
336 /* Return true if symbol can be discarded by linker from the binary.
337 Assume that symbol is used (so there is no need to take into account
338 garbage collecting linkers)
339
340 This can happen for comdats, commons and weaks when they are previaled
341 by other definition at static linking time. */
d52f5295
ML
342 inline bool
343 can_be_discarded_p (void)
344 {
345 return (DECL_EXTERNAL (decl)
f1703a2e
JH
346 || ((get_comdat_group ()
347 || DECL_COMMON (decl)
348 || (DECL_SECTION_NAME (decl) && DECL_WEAK (decl)))
349 && ((resolution != LDPR_PREVAILING_DEF
350 && resolution != LDPR_PREVAILING_DEF_IRONLY_EXP)
351 || flag_incremental_link)
352 && resolution != LDPR_PREVAILING_DEF_IRONLY));
d52f5295
ML
353 }
354
355 /* Return true if NODE is local to a particular COMDAT group, and must not
356 be named from outside the COMDAT. This is used for C++ decloned
357 constructors. */
358 inline bool comdat_local_p (void)
359 {
360 return (same_comdat_group && !TREE_PUBLIC (decl));
361 }
362
363 /* Return true if ONE and TWO are part of the same COMDAT group. */
364 inline bool in_same_comdat_group_p (symtab_node *target);
365
d52f5295
ML
366 /* Return true if symbol is known to be nonzero. */
367 bool nonzero_address ();
368
3cb251b7
JH
369 /* Return 0 if symbol is known to have different address than S2,
370 Return 1 if symbol is known to have same address as S2,
b2539e1e
JH
371 return 2 otherwise.
372
373 If MEMORY_ACCESSED is true, assume that both memory pointer to THIS
374 and S2 is going to be accessed. This eliminates the situations when
375 either THIS or S2 is NULL and is seful for comparing bases when deciding
376 about memory aliasing. */
377 int equal_address_to (symtab_node *s2, bool memory_accessed = false);
3cb251b7 378
0a7246ee
JH
379 /* Return true if symbol's address may possibly be compared to other
380 symbol's address. */
381 bool address_matters_p ();
382
383 /* Return true if NODE's address can be compared. This use properties
384 of NODE only and does not look if the address is actually taken in
385 interesting way. For that use ADDRESS_MATTERS_P instead. */
386 bool address_can_be_compared_p (void);
387
d52f5295
ML
388 /* Return symbol table node associated with DECL, if any,
389 and NULL otherwise. */
390 static inline symtab_node *get (const_tree decl)
391 {
d52f5295
ML
392 /* Check that we are called for sane type of object - functions
393 and static or external variables. */
394 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL
395 || (TREE_CODE (decl) == VAR_DECL
396 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl)
397 || in_lto_p)));
398 /* Check that the mapping is sane - perhaps this check can go away,
399 but at the moment frontends tends to corrupt the mapping by calling
400 memcpy/memset on the tree nodes. */
401 gcc_checking_assert (!decl->decl_with_vis.symtab_node
402 || decl->decl_with_vis.symtab_node->decl == decl);
d52f5295
ML
403 return decl->decl_with_vis.symtab_node;
404 }
405
f7217cde
JH
406 /* Try to find a symtab node for declaration DECL and if it does not
407 exist or if it corresponds to an inline clone, create a new one. */
408 static inline symtab_node * get_create (tree node);
409
3dafb85c
ML
410 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
411 Return NULL if there's no such node. */
412 static symtab_node *get_for_asmname (const_tree asmname);
413
d52f5295
ML
414 /* Dump symbol table to F. */
415 static void dump_table (FILE *);
416
417 /* Dump symbol table to stderr. */
1ad784e2 418 static void DEBUG_FUNCTION debug_symtab (void);
d52f5295
ML
419
420 /* Verify symbol table for internal consistency. */
421 static DEBUG_FUNCTION void verify_symtab_nodes (void);
422
b2b29377
MM
423 /* Perform internal consistency checks, if they are enabled. */
424 static inline void checking_verify_symtab_nodes (void);
425
1f00098b 426 /* Type of the symbol. */
b8dbdb12
RG
427 ENUM_BITFIELD (symtab_type) type : 8;
428
429 /* The symbols resolution. */
430 ENUM_BITFIELD (ld_plugin_symbol_resolution) resolution : 8;
431
e70670cf
JH
432 /*** Flags representing the symbol type. ***/
433
434 /* True when symbol corresponds to a definition in current unit.
3dafb85c 435 set via finalize_function or finalize_decl */
e70670cf 436 unsigned definition : 1;
9041d2e6
ML
437 /* True when symbol is an alias.
438 Set by ssemble_alias. */
e70670cf 439 unsigned alias : 1;
71e54687
JH
440 /* When true the alias is translated into its target symbol either by GCC
441 or assembler (it also may just be a duplicate declaration of the same
442 linker name).
443
444 Currently transparent aliases come in three different flavors
445 - aliases having the same assembler name as their target (aka duplicated
446 declarations). In this case the assembler names compare via
447 assembler_names_equal_p and weakref is false
448 - aliases that are renamed at a time being output to final file
449 by varasm.c. For those DECL_ASSEMBLER_NAME have
450 IDENTIFIER_TRANSPARENT_ALIAS set and thus also their assembler
451 name must be unique.
452 Weakrefs belong to this cateogry when we target assembler without
453 .weakref directive.
454 - weakrefs that are renamed by assembler via .weakref directive.
455 In this case the alias may or may not be definition (depending if
456 target declaration was seen by the compiler), weakref is set.
457 Unless we are before renaming statics, assembler names are different.
458
459 Given that we now support duplicate declarations, the second option is
460 redundant and will be removed. */
461 unsigned transparent_alias : 1;
08346abd
JH
462 /* True when alias is a weakref. */
463 unsigned weakref : 1;
40a7fe1e 464 /* C++ frontend produce same body aliases and extra name aliases for
688010ba 465 virtual functions and vtables that are obviously equivalent.
40a7fe1e
JH
466 Those aliases are bit special, especially because C++ frontend
467 visibility code is so ugly it can not get them right at first time
468 and their visibility needs to be copied from their "masters" at
469 the end of parsing. */
470 unsigned cpp_implicit_alias : 1;
e70670cf
JH
471 /* Set once the definition was analyzed. The list of references and
472 other properties are built during analysis. */
473 unsigned analyzed : 1;
6de88c6a
JH
474 /* Set for write-only variables. */
475 unsigned writeonly : 1;
f7217cde
JH
476 /* Visibility of symbol was used for further optimization; do not
477 permit further changes. */
478 unsigned refuse_visibility_changes : 1;
e70670cf
JH
479
480 /*** Visibility and linkage flags. ***/
481
b8dbdb12
RG
482 /* Set when function is visible by other units. */
483 unsigned externally_visible : 1;
7861b648
AK
484 /* Don't reorder to other symbols having this set. */
485 unsigned no_reorder : 1;
4bcfd75c 486 /* The symbol will be assumed to be used in an invisible way (like
edb983b2 487 by an toplevel asm statement). */
b8dbdb12 488 unsigned force_output : 1;
edb983b2
JH
489 /* Like FORCE_OUTPUT, but in the case it is ABI requiring the symbol to be
490 exported. Unlike FORCE_OUTPUT this flag gets cleared to symbols promoted
491 to static and it does not inhibit optimization. */
492 unsigned forced_by_abi : 1;
702d8703
JH
493 /* True when the name is known to be unique and thus it does not need mangling. */
494 unsigned unique_name : 1;
e257a17c
JH
495 /* Specify whether the section was set by user or by
496 compiler via -ffunction-sections. */
497 unsigned implicit_section : 1;
3d8d0043
MJ
498 /* True when body and other characteristics have been removed by
499 symtab_remove_unreachable_nodes. */
500 unsigned body_removed : 1;
b8dbdb12 501
e70670cf
JH
502 /*** WHOPR Partitioning flags.
503 These flags are used at ltrans stage when only part of the callgraph is
504 available. ***/
b8dbdb12 505
e70670cf
JH
506 /* Set when variable is used from other LTRANS partition. */
507 unsigned used_from_other_partition : 1;
9041d2e6 508 /* Set when function is available in the other LTRANS partition.
e70670cf
JH
509 During WPA output it is used to mark nodes that are present in
510 multiple partitions. */
511 unsigned in_other_partition : 1;
b8dbdb12 512
b8dbdb12 513
e70670cf
JH
514
515 /*** other flags. ***/
516
517 /* Set when symbol has address taken. */
518 unsigned address_taken : 1;
569b1784
JH
519 /* Set when init priority is set. */
520 unsigned in_init_priority_hash : 1;
e70670cf 521
1f6be682
IV
522 /* Set when symbol needs to be streamed into LTO bytecode for LTO, or in case
523 of offloading, for separate compilation for a different target. */
524 unsigned need_lto_streaming : 1;
525
526 /* Set when symbol can be streamed into bytecode for offloading. */
527 unsigned offloadable : 1;
528
e70670cf
JH
529
530 /* Ordering of all symtab entries. */
531 int order;
532
533 /* Declaration representing the symbol. */
534 tree decl;
960bfb69 535
2aae7680 536 /* Linked list of symbol table entries starting with symtab_nodes. */
5e20cdc9
DM
537 symtab_node *next;
538 symtab_node *previous;
e70670cf 539
1ab24192 540 /* Linked list of symbols with the same asm name. There may be multiple
e70670cf
JH
541 entries for single symbol name during LTO, because symbols are renamed
542 only after partitioning.
543
544 Because inline clones are kept in the assembler name has, they also produce
545 duplicate entries.
546
547 There are also several long standing bugs where frontends and builtin
548 code produce duplicated decls. */
5e20cdc9
DM
549 symtab_node *next_sharing_asm_name;
550 symtab_node *previous_sharing_asm_name;
2aae7680 551
d52f5295
ML
552 /* Circular list of nodes in the same comdat group if non-NULL. */
553 symtab_node *same_comdat_group;
e55637b7 554
e70670cf 555 /* Vectors of referring and referenced entities. */
3dafb85c 556 ipa_ref_list ref_list;
e70670cf 557
40a7fe1e
JH
558 /* Alias target. May be either DECL pointer or ASSEMBLER_NAME pointer
559 depending to what was known to frontend on the creation time.
560 Once alias is resolved, this pointer become NULL. */
561 tree alias_target;
562
e70670cf
JH
563 /* File stream where this node is being written to. */
564 struct lto_file_decl_data * lto_file_data;
565
960bfb69 566 PTR GTY ((skip)) aux;
aede2c10
JH
567
568 /* Comdat group the symbol is in. Can be private if GGC allowed that. */
f961457f 569 tree x_comdat_group;
24d047a3
JH
570
571 /* Section name. Again can be private, if allowed. */
f961457f 572 section_hash_entry *x_section;
e257a17c 573
d52f5295
ML
574protected:
575 /* Dump base fields of symtab nodes to F. Not to be used directly. */
576 void dump_base (FILE *);
569b1784 577
d52f5295
ML
578 /* Verify common part of symtab node. */
579 bool DEBUG_FUNCTION verify_base (void);
89330618 580
d52f5295
ML
581 /* Remove node from symbol table. This function is not used directly, but via
582 cgraph/varpool node removal routines. */
583 void unregister (void);
584
585 /* Return the initialization and finalization priority information for
586 DECL. If there is no previous priority information, a freshly
587 allocated structure is returned. */
588 struct symbol_priority_map *priority_info (void);
589
31de7606
JH
590 /* Worker for call_for_symbol_and_aliases_1. */
591 bool call_for_symbol_and_aliases_1 (bool (*callback) (symtab_node *, void *),
592 void *data,
593 bool include_overwrite);
d52f5295
ML
594private:
595 /* Worker for set_section. */
596 static bool set_section (symtab_node *n, void *s);
597
598 /* Worker for symtab_resolve_alias. */
599 static bool set_implicit_section (symtab_node *n, void *);
600
601 /* Worker searching noninterposable alias. */
602 static bool noninterposable_alias (symtab_node *node, void *data);
31de7606
JH
603
604 /* Worker for ultimate_alias_target. */
f13fe18b
JH
605 symtab_node *ultimate_alias_target_1 (enum availability *avail = NULL,
606 symtab_node *ref = NULL);
1f00098b 607};
1c4a429a 608
b2b29377
MM
609inline void
610symtab_node::checking_verify_symtab_nodes (void)
611{
612 if (flag_checking)
613 symtab_node::verify_symtab_nodes ();
614}
615
e55637b7
ML
616/* Walk all aliases for NODE. */
617#define FOR_EACH_ALIAS(node, alias) \
d52f5295 618 for (unsigned x_i = 0; node->iterate_direct_aliases (x_i, alias); x_i++)
6b02a499 619
d7f09764
DN
620/* This is the information that is put into the cgraph local structure
621 to recover a function. */
622struct lto_file_decl_data;
623
8a4a83ed 624extern const char * const cgraph_availability_names[];
430c6ceb 625extern const char * const ld_plugin_symbol_resolution_names[];
714c800f 626extern const char * const tls_model_names[];
8a4a83ed 627
6744a6ab
JH
628/* Information about thunk, used only for same body aliases. */
629
630struct GTY(()) cgraph_thunk_info {
631 /* Information about the thunk. */
632 HOST_WIDE_INT fixed_offset;
633 HOST_WIDE_INT virtual_value;
634 tree alias;
635 bool this_adjusting;
636 bool virtual_offset_p;
d5e254e1 637 bool add_pointer_bounds_args;
6744a6ab
JH
638 /* Set to true when alias node is thunk. */
639 bool thunk_p;
640};
641
dafc5b82 642/* Information about the function collected locally.
25c84396 643 Available after function is analyzed. */
dafc5b82 644
d1b38208 645struct GTY(()) cgraph_local_info {
026c3cfd
AH
646 /* Set when function is visible in current compilation unit only and
647 its address is never taken. */
b4e19405 648 unsigned local : 1;
6674a6ce 649
124f1be6
MJ
650 /* False when there is something makes versioning impossible. */
651 unsigned versionable : 1;
652
61e03ffc
JH
653 /* False when function calling convention and signature can not be changed.
654 This is the case when __builtin_apply_args is used. */
655 unsigned can_change_signature : 1;
656
95c755e9
JH
657 /* True when the function has been originally extern inline, but it is
658 redefined now. */
b4e19405 659 unsigned redefined_extern_inline : 1;
0a35513e
AH
660
661 /* True if the function may enter serial irrevocable mode. */
662 unsigned tm_may_enter_irr : 1;
dafc5b82
JH
663};
664
665/* Information about the function that needs to be computed globally
726a989a 666 once compilation is finished. Available only with -funit-at-a-time. */
dafc5b82 667
d1b38208 668struct GTY(()) cgraph_global_info {
726a989a
RB
669 /* For inline clones this points to the function they will be
670 inlined into. */
d52f5295 671 cgraph_node *inlined_to;
dafc5b82
JH
672};
673
9187e02d
JH
674/* Represent which DECL tree (or reference to such tree)
675 will be replaced by another tree while versioning. */
676struct GTY(()) ipa_replace_map
677{
678 /* The tree that will be replaced. */
679 tree old_tree;
680 /* The new (replacing) tree. */
681 tree new_tree;
922f15c2
JH
682 /* Parameter number to replace, when old_tree is NULL. */
683 int parm_num;
9187e02d
JH
684 /* True when a substitution should be done, false otherwise. */
685 bool replace_p;
686 /* True when we replace a reference to old_tree. */
687 bool ref_p;
688};
9187e02d
JH
689
690struct GTY(()) cgraph_clone_info
691{
d52f5295 692 vec<ipa_replace_map *, va_gc> *tree_map;
9187e02d 693 bitmap args_to_skip;
08ad1d6d 694 bitmap combined_args_to_skip;
9187e02d
JH
695};
696
0136f8f0
AH
697enum cgraph_simd_clone_arg_type
698{
699 SIMD_CLONE_ARG_TYPE_VECTOR,
700 SIMD_CLONE_ARG_TYPE_UNIFORM,
d9a6bd32 701 /* These are only for integer/pointer arguments passed by value. */
0136f8f0
AH
702 SIMD_CLONE_ARG_TYPE_LINEAR_CONSTANT_STEP,
703 SIMD_CLONE_ARG_TYPE_LINEAR_VARIABLE_STEP,
e01d41e5 704 /* These 6 are only for reference type arguments or arguments passed
d9a6bd32
JJ
705 by reference. */
706 SIMD_CLONE_ARG_TYPE_LINEAR_REF_CONSTANT_STEP,
e01d41e5 707 SIMD_CLONE_ARG_TYPE_LINEAR_REF_VARIABLE_STEP,
d9a6bd32 708 SIMD_CLONE_ARG_TYPE_LINEAR_UVAL_CONSTANT_STEP,
e01d41e5 709 SIMD_CLONE_ARG_TYPE_LINEAR_UVAL_VARIABLE_STEP,
d9a6bd32 710 SIMD_CLONE_ARG_TYPE_LINEAR_VAL_CONSTANT_STEP,
e01d41e5 711 SIMD_CLONE_ARG_TYPE_LINEAR_VAL_VARIABLE_STEP,
0136f8f0
AH
712 SIMD_CLONE_ARG_TYPE_MASK
713};
714
715/* Function arguments in the original function of a SIMD clone.
716 Supplementary data for `struct simd_clone'. */
717
718struct GTY(()) cgraph_simd_clone_arg {
719 /* Original function argument as it originally existed in
720 DECL_ARGUMENTS. */
721 tree orig_arg;
722
723 /* orig_arg's function (or for extern functions type from
724 TYPE_ARG_TYPES). */
725 tree orig_type;
726
727 /* If argument is a vector, this holds the vector version of
728 orig_arg that after adjusting the argument types will live in
729 DECL_ARGUMENTS. Otherwise, this is NULL.
730
731 This basically holds:
732 vector(simdlen) __typeof__(orig_arg) new_arg. */
733 tree vector_arg;
734
735 /* vector_arg's type (or for extern functions new vector type. */
736 tree vector_type;
737
738 /* If argument is a vector, this holds the array where the simd
739 argument is held while executing the simd clone function. This
740 is a local variable in the cloned function. Its content is
741 copied from vector_arg upon entry to the clone.
742
743 This basically holds:
744 __typeof__(orig_arg) simd_array[simdlen]. */
745 tree simd_array;
746
747 /* A SIMD clone's argument can be either linear (constant or
748 variable), uniform, or vector. */
749 enum cgraph_simd_clone_arg_type arg_type;
750
d9a6bd32 751 /* For arg_type SIMD_CLONE_ARG_TYPE_LINEAR_*CONSTANT_STEP this is
0136f8f0 752 the constant linear step, if arg_type is
e01d41e5 753 SIMD_CLONE_ARG_TYPE_LINEAR_*VARIABLE_STEP, this is index of
0136f8f0
AH
754 the uniform argument holding the step, otherwise 0. */
755 HOST_WIDE_INT linear_step;
756
757 /* Variable alignment if available, otherwise 0. */
758 unsigned int alignment;
759};
760
761/* Specific data for a SIMD function clone. */
762
763struct GTY(()) cgraph_simd_clone {
764 /* Number of words in the SIMD lane associated with this clone. */
765 unsigned int simdlen;
766
767 /* Number of annotated function arguments in `args'. This is
768 usually the number of named arguments in FNDECL. */
769 unsigned int nargs;
770
771 /* Max hardware vector size in bits for integral vectors. */
772 unsigned int vecsize_int;
773
774 /* Max hardware vector size in bits for floating point vectors. */
775 unsigned int vecsize_float;
776
5f490f9f
JJ
777 /* Machine mode of the mask argument(s), if they are to be passed
778 as bitmasks in integer argument(s). VOIDmode if masks are passed
779 as vectors of characteristic type. */
780 machine_mode mask_mode;
781
026c3cfd 782 /* The mangling character for a given vector size. This is used
0136f8f0
AH
783 to determine the ISA mangling bit as specified in the Intel
784 Vector ABI. */
785 unsigned char vecsize_mangle;
786
787 /* True if this is the masked, in-branch version of the clone,
788 otherwise false. */
789 unsigned int inbranch : 1;
790
791 /* True if this is a Cilk Plus variant. */
792 unsigned int cilk_elemental : 1;
793
794 /* Doubly linked list of SIMD clones. */
d52f5295 795 cgraph_node *prev_clone, *next_clone;
0136f8f0
AH
796
797 /* Original cgraph node the SIMD clones were created for. */
d52f5295 798 cgraph_node *origin;
0136f8f0
AH
799
800 /* Annotated function arguments for the original function. */
3dafb85c 801 cgraph_simd_clone_arg GTY((length ("%h.nargs"))) args[1];
0136f8f0
AH
802};
803
d52f5295 804/* Function Multiversioning info. */
2a22f99c 805struct GTY((for_user)) cgraph_function_version_info {
d52f5295
ML
806 /* The cgraph_node for which the function version info is stored. */
807 cgraph_node *this_node;
808 /* Chains all the semantically identical function versions. The
809 first function in this chain is the version_info node of the
810 default function. */
3dafb85c 811 cgraph_function_version_info *prev;
d52f5295
ML
812 /* If this version node corresponds to a dispatcher for function
813 versions, this points to the version info node of the default
814 function, the first node in the chain. */
3dafb85c 815 cgraph_function_version_info *next;
d52f5295
ML
816 /* If this node corresponds to a function version, this points
817 to the dispatcher function decl, which is the function that must
818 be called to execute the right function version at run-time.
819
820 If this cgraph node is a dispatcher (if dispatcher_function is
821 true, in the cgraph_node struct) for function versions, this
822 points to resolver function, which holds the function body of the
823 dispatcher. The dispatcher decl is an alias to the resolver
824 function decl. */
825 tree dispatcher_resolver;
826};
827
828#define DEFCIFCODE(code, type, string) CIF_ ## code,
829/* Reasons for inlining failures. */
830
831enum cgraph_inline_failed_t {
832#include "cif-code.def"
833 CIF_N_REASONS
834};
835
836enum cgraph_inline_failed_type_t
837{
838 CIF_FINAL_NORMAL = 0,
839 CIF_FINAL_ERROR
840};
841
842struct cgraph_edge;
5fefcf92 843
ca752f39 844struct cgraph_edge_hasher : ggc_ptr_hash<cgraph_edge>
2a22f99c 845{
355fe088 846 typedef gimple *compare_type;
2a22f99c
TS
847
848 static hashval_t hash (cgraph_edge *);
355fe088
TS
849 static hashval_t hash (gimple *);
850 static bool equal (cgraph_edge *, gimple *);
2a22f99c
TS
851};
852
ba228239 853/* The cgraph data structure.
e0bb17a8 854 Each function decl has assigned cgraph_node listing callees and callers. */
1c4a429a 855
5e20cdc9 856struct GTY((tag ("SYMTAB_FUNCTION"))) cgraph_node : public symtab_node {
a3bfa8b8 857public:
d52f5295
ML
858 /* Remove the node from cgraph and all inline clones inlined into it.
859 Skip however removal of FORBIDDEN_NODE and return true if it needs to be
860 removed. This allows to call the function from outer loop walking clone
861 tree. */
862 bool remove_symbol_and_inline_clones (cgraph_node *forbidden_node = NULL);
863
864 /* Record all references from cgraph_node that are taken
865 in statement STMT. */
355fe088 866 void record_stmt_references (gimple *stmt);
d52f5295
ML
867
868 /* Like cgraph_set_call_stmt but walk the clone tree and update all
869 clones sharing the same function body.
870 When WHOLE_SPECULATIVE_EDGES is true, all three components of
871 speculative edge gets updated. Otherwise we update only direct
872 call. */
355fe088 873 void set_call_stmt_including_clones (gimple *old_stmt, gcall *new_stmt,
d52f5295
ML
874 bool update_speculative = true);
875
876 /* Walk the alias chain to return the function cgraph_node is alias of.
877 Walk through thunk, too.
f13fe18b
JH
878 When AVAILABILITY is non-NULL, get minimal availability in the chain.
879 When REF is non-NULL, assume that reference happens in symbol REF
880 when determining the availability. */
881 cgraph_node *function_symbol (enum availability *avail = NULL,
882 struct symtab_node *ref = NULL);
d52f5295 883
6cbde2e3
BE
884 /* Walk the alias chain to return the function cgraph_node is alias of.
885 Walk through non virtual thunks, too. Thus we return either a function
886 or a virtual thunk node.
f13fe18b
JH
887 When AVAILABILITY is non-NULL, get minimal availability in the chain.
888 When REF is non-NULL, assume that reference happens in symbol REF
889 when determining the availability. */
6cbde2e3 890 cgraph_node *function_or_virtual_thunk_symbol
f13fe18b
JH
891 (enum availability *avail = NULL,
892 struct symtab_node *ref = NULL);
6cbde2e3 893
d52f5295
ML
894 /* Create node representing clone of N executed COUNT times. Decrease
895 the execution counts from original node too.
896 The new clone will have decl set to DECL that may or may not be the same
897 as decl of N.
898
899 When UPDATE_ORIGINAL is true, the counts are subtracted from the original
900 function's profile to reflect the fact that part of execution is handled
901 by node.
902 When CALL_DUPLICATOIN_HOOK is true, the ipa passes are acknowledged about
903 the new clone. Otherwise the caller is responsible for doing so later.
904
905 If the new node is being inlined into another one, NEW_INLINED_TO should be
906 the outline function the new one is (even indirectly) inlined to.
907 All hooks will see this in node's global.inlined_to, when invoked.
0bdad123
ML
908 Can be NULL if the node is not inlined. SUFFIX is string that is appended
909 to the original name. */
d52f5295
ML
910 cgraph_node *create_clone (tree decl, gcov_type count, int freq,
911 bool update_original,
912 vec<cgraph_edge *> redirect_callers,
913 bool call_duplication_hook,
3dafb85c 914 cgraph_node *new_inlined_to,
0bdad123 915 bitmap args_to_skip, const char *suffix = NULL);
d52f5295
ML
916
917 /* Create callgraph node clone with new declaration. The actual body will
918 be copied later at compilation stage. */
919 cgraph_node *create_virtual_clone (vec<cgraph_edge *> redirect_callers,
920 vec<ipa_replace_map *, va_gc> *tree_map,
921 bitmap args_to_skip, const char * suffix);
922
923 /* cgraph node being removed from symbol table; see if its entry can be
924 replaced by other inline clone. */
925 cgraph_node *find_replacement (void);
926
927 /* Create a new cgraph node which is the new version of
928 callgraph node. REDIRECT_CALLERS holds the callers
929 edges which should be redirected to point to
930 NEW_VERSION. ALL the callees edges of the node
931 are cloned to the new version node. Return the new
932 version node.
933
934 If non-NULL BLOCK_TO_COPY determine what basic blocks
935 was copied to prevent duplications of calls that are dead
0bdad123
ML
936 in the clone.
937
938 SUFFIX is string that is appended to the original name. */
d52f5295
ML
939
940 cgraph_node *create_version_clone (tree new_decl,
941 vec<cgraph_edge *> redirect_callers,
0bdad123
ML
942 bitmap bbs_to_copy,
943 const char *suffix = NULL);
d52f5295
ML
944
945 /* Perform function versioning.
946 Function versioning includes copying of the tree and
947 a callgraph update (creating a new cgraph node and updating
948 its callees and callers).
949
950 REDIRECT_CALLERS varray includes the edges to be redirected
951 to the new version.
952
953 TREE_MAP is a mapping of tree nodes we want to replace with
954 new ones (according to results of prior analysis).
955
956 If non-NULL ARGS_TO_SKIP determine function parameters to remove
957 from new version.
958 If SKIP_RETURN is true, the new version will return void.
959 If non-NULL BLOCK_TO_COPY determine what basic blocks to copy.
960 If non_NULL NEW_ENTRY determine new entry BB of the clone.
961
962 Return the new version's cgraph node. */
963 cgraph_node *create_version_clone_with_body
964 (vec<cgraph_edge *> redirect_callers,
965 vec<ipa_replace_map *, va_gc> *tree_map, bitmap args_to_skip,
966 bool skip_return, bitmap bbs_to_copy, basic_block new_entry_block,
967 const char *clone_name);
968
969 /* Insert a new cgraph_function_version_info node into cgraph_fnver_htab
970 corresponding to cgraph_node. */
3dafb85c 971 cgraph_function_version_info *insert_new_function_version (void);
d52f5295
ML
972
973 /* Get the cgraph_function_version_info node corresponding to node. */
3dafb85c 974 cgraph_function_version_info *function_version (void);
d52f5295
ML
975
976 /* Discover all functions and variables that are trivially needed, analyze
977 them as well as all functions and variables referred by them */
978 void analyze (void);
979
980 /* Add thunk alias into callgraph. The alias declaration is ALIAS and it
981 aliases DECL with an adjustments made into the first parameter.
982 See comments in thunk_adjust for detail on the parameters. */
983 cgraph_node * create_thunk (tree alias, tree, bool this_adjusting,
984 HOST_WIDE_INT fixed_offset,
985 HOST_WIDE_INT virtual_value,
986 tree virtual_offset,
987 tree real_alias);
988
989
990 /* Return node that alias is aliasing. */
991 inline cgraph_node *get_alias_target (void);
992
993 /* Given function symbol, walk the alias chain to return the function node
994 is alias of. Do not walk through thunks.
f13fe18b
JH
995 When AVAILABILITY is non-NULL, get minimal availability in the chain.
996 When REF is non-NULL, assume that reference happens in symbol REF
997 when determining the availability. */
d52f5295 998
f13fe18b
JH
999 cgraph_node *ultimate_alias_target (availability *availability = NULL,
1000 symtab_node *ref = NULL);
d52f5295
ML
1001
1002 /* Expand thunk NODE to gimple if possible.
1003 When FORCE_GIMPLE_THUNK is true, gimple thunk is created and
1004 no assembler is produced.
1005 When OUTPUT_ASM_THUNK is true, also produce assembler for
1006 thunks that are not lowered. */
1007 bool expand_thunk (bool output_asm_thunks, bool force_gimple_thunk);
1008
6a4bad95
MJ
1009 /* Call expand_thunk on all callers that are thunks and analyze those
1010 nodes that were expanded. */
1011 void expand_all_artificial_thunks ();
1012
3dafb85c
ML
1013 /* Assemble thunks and aliases associated to node. */
1014 void assemble_thunks_and_aliases (void);
1015
1016 /* Expand function specified by node. */
1017 void expand (void);
1018
d52f5295
ML
1019 /* As an GCC extension we allow redefinition of the function. The
1020 semantics when both copies of bodies differ is not well defined.
1021 We replace the old body with new body so in unit at a time mode
1022 we always use new body, while in normal mode we may end up with
1023 old body inlined into some functions and new body expanded and
1024 inlined in others. */
1025 void reset (void);
1026
1027 /* Creates a wrapper from cgraph_node to TARGET node. Thunk is used for this
1028 kind of wrapper method. */
1029 void create_wrapper (cgraph_node *target);
1030
1031 /* Verify cgraph nodes of the cgraph node. */
1032 void DEBUG_FUNCTION verify_node (void);
1033
1034 /* Remove function from symbol table. */
1035 void remove (void);
1036
1037 /* Dump call graph node to file F. */
1038 void dump (FILE *f);
1039
1040 /* Dump call graph node to stderr. */
1041 void DEBUG_FUNCTION debug (void);
1042
1043 /* When doing LTO, read cgraph_node's body from disk if it is not already
1044 present. */
70486010
JH
1045 bool get_untransformed_body (void);
1046
1047 /* Prepare function body. When doing LTO, read cgraph_node's body from disk
1048 if it is not already present. When some IPA transformations are scheduled,
1049 apply them. */
d52f5295
ML
1050 bool get_body (void);
1051
1052 /* Release memory used to represent body of function.
1053 Use this only for functions that are released before being translated to
1054 target code (i.e. RTL). Functions that are compiled to RTL and beyond
1055 are free'd in final.c via free_after_compilation(). */
bf898b30 1056 void release_body (bool keep_arguments = false);
d52f5295 1057
8ccda8bc
EB
1058 /* Return the DECL_STRUCT_FUNCTION of the function. */
1059 struct function *get_fun (void);
1060
d52f5295
ML
1061 /* cgraph_node is no longer nested function; update cgraph accordingly. */
1062 void unnest (void);
1063
1064 /* Bring cgraph node local. */
1065 void make_local (void);
1066
1067 /* Likewise indicate that a node is having address taken. */
1068 void mark_address_taken (void);
1069
1070 /* Set fialization priority to PRIORITY. */
1071 void set_fini_priority (priority_type priority);
1072
1073 /* Return the finalization priority. */
1074 priority_type get_fini_priority (void);
1075
1076 /* Create edge from a given function to CALLEE in the cgraph. */
3dafb85c 1077 cgraph_edge *create_edge (cgraph_node *callee,
538dd0b7 1078 gcall *call_stmt, gcov_type count,
3dafb85c
ML
1079 int freq);
1080
d52f5295
ML
1081 /* Create an indirect edge with a yet-undetermined callee where the call
1082 statement destination is a formal parameter of the caller with index
1083 PARAM_INDEX. */
538dd0b7 1084 cgraph_edge *create_indirect_edge (gcall *call_stmt, int ecf_flags,
3dafb85c
ML
1085 gcov_type count, int freq,
1086 bool compute_indirect_info = true);
d52f5295
ML
1087
1088 /* Like cgraph_create_edge walk the clone tree and update all clones sharing
1089 same function body. If clones already have edge for OLD_STMT; only
1090 update the edge same way as cgraph_set_call_stmt_including_clones does. */
3dafb85c 1091 void create_edge_including_clones (cgraph_node *callee,
355fe088 1092 gimple *old_stmt, gcall *stmt,
d52f5295
ML
1093 gcov_type count,
1094 int freq,
1095 cgraph_inline_failed_t reason);
1096
1097 /* Return the callgraph edge representing the GIMPLE_CALL statement
1098 CALL_STMT. */
355fe088 1099 cgraph_edge *get_edge (gimple *call_stmt);
d52f5295
ML
1100
1101 /* Collect all callers of cgraph_node and its aliases that are known to lead
4a414de8 1102 to NODE (i.e. are not overwritable) and that are not thunks. */
d52f5295
ML
1103 vec<cgraph_edge *> collect_callers (void);
1104
1105 /* Remove all callers from the node. */
1106 void remove_callers (void);
1107
1108 /* Remove all callees from the node. */
1109 void remove_callees (void);
1110
1111 /* Return function availability. See cgraph.h for description of individual
1112 return values. */
f13fe18b 1113 enum availability get_availability (symtab_node *ref = NULL);
d52f5295
ML
1114
1115 /* Set TREE_NOTHROW on cgraph_node's decl and on aliases of the node
1116 if any to NOTHROW. */
a2b056a3 1117 bool set_nothrow_flag (bool nothrow);
d52f5295 1118
69a4e898
JH
1119 /* If SET_CONST is true, mark function, aliases and thunks to be ECF_CONST.
1120 If SET_CONST if false, clear the flag.
1121
1122 When setting the flag be careful about possible interposition and
1123 do not set the flag for functions that can be interposet and set pure
1124 flag for functions that can bind to other definition.
1125
1126 Return true if any change was done. */
1127
1128 bool set_const_flag (bool set_const, bool looping);
d52f5295
ML
1129
1130 /* Set DECL_PURE_P on cgraph_node's decl and on aliases of the node
69a4e898
JH
1131 if any to PURE.
1132
1133 When setting the flag, be careful about possible interposition.
1134 Return true if any change was done. */
1135
1136 bool set_pure_flag (bool pure, bool looping);
d52f5295 1137
6cbde2e3 1138 /* Call callback on function and aliases associated to the function.
d52f5295
ML
1139 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1140 skipped. */
1141
1142 bool call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
1143 void *),
1144 void *data, bool include_overwritable);
1145
6cbde2e3 1146 /* Call callback on cgraph_node, thunks and aliases associated to NODE.
d52f5295 1147 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
6cbde2e3 1148 skipped. When EXCLUDE_VIRTUAL_THUNKS is true, virtual thunks are
d52f5295
ML
1149 skipped. */
1150 bool call_for_symbol_thunks_and_aliases (bool (*callback) (cgraph_node *node,
6cbde2e3
BE
1151 void *data),
1152 void *data,
1153 bool include_overwritable,
1154 bool exclude_virtual_thunks = false);
d52f5295 1155
d52f5295
ML
1156 /* Likewise indicate that a node is needed, i.e. reachable via some
1157 external means. */
1158 inline void mark_force_output (void);
1159
1160 /* Return true when function can be marked local. */
1161 bool local_p (void);
1162
1163 /* Return true if cgraph_node can be made local for API change.
1164 Extern inline functions and C++ COMDAT functions can be made local
1165 at the expense of possible code size growth if function is used in multiple
1166 compilation units. */
1167 bool can_be_local_p (void);
1168
1169 /* Return true when cgraph_node can not return or throw and thus
1170 it is safe to ignore its side effects for IPA analysis. */
1171 bool cannot_return_p (void);
1172
1173 /* Return true when function cgraph_node and all its aliases are only called
1174 directly.
1175 i.e. it is not externally visible, address was not taken and
1176 it is not used in any other non-standard way. */
1177 bool only_called_directly_p (void);
1178
1179 /* Return true when function is only called directly or it has alias.
1180 i.e. it is not externally visible, address was not taken and
1181 it is not used in any other non-standard way. */
1182 inline bool only_called_directly_or_aliased_p (void);
1183
1184 /* Return true when function cgraph_node can be expected to be removed
1185 from program when direct calls in this compilation unit are removed.
1186
1187 As a special case COMDAT functions are
1188 cgraph_can_remove_if_no_direct_calls_p while the are not
1189 cgraph_only_called_directly_p (it is possible they are called from other
1190 unit)
1191
1192 This function behaves as cgraph_only_called_directly_p because eliminating
1193 all uses of COMDAT function does not make it necessarily disappear from
1194 the program unless we are compiling whole program or we do LTO. In this
1195 case we know we win since dynamic linking will not really discard the
e0d514da
JH
1196 linkonce section.
1197
1198 If WILL_INLINE is true, assume that function will be inlined into all the
1199 direct calls. */
1200 bool will_be_removed_from_program_if_no_direct_calls_p
1201 (bool will_inline = false);
d52f5295
ML
1202
1203 /* Return true when function can be removed from callgraph
e0d514da
JH
1204 if all direct calls and references are eliminated. The function does
1205 not take into account comdat groups. */
d52f5295
ML
1206 bool can_remove_if_no_direct_calls_and_refs_p (void);
1207
1208 /* Return true when function cgraph_node and its aliases can be removed from
e0d514da
JH
1209 callgraph if all direct calls are eliminated.
1210 If WILL_INLINE is true, assume that function will be inlined into all the
1211 direct calls. */
1212 bool can_remove_if_no_direct_calls_p (bool will_inline = false);
d52f5295
ML
1213
1214 /* Return true when callgraph node is a function with Gimple body defined
1215 in current unit. Functions can also be define externally or they
1216 can be thunks with no Gimple representation.
1217
1218 Note that at WPA stage, the function body may not be present in memory. */
1219 inline bool has_gimple_body_p (void);
1220
1221 /* Return true if function should be optimized for size. */
1222 bool optimize_for_size_p (void);
1223
1224 /* Dump the callgraph to file F. */
1225 static void dump_cgraph (FILE *f);
1226
1227 /* Dump the call graph to stderr. */
3dafb85c
ML
1228 static inline
1229 void debug_cgraph (void)
d52f5295
ML
1230 {
1231 dump_cgraph (stderr);
1232 }
1233
1234 /* Record that DECL1 and DECL2 are semantically identical function
1235 versions. */
1236 static void record_function_versions (tree decl1, tree decl2);
1237
1238 /* Remove the cgraph_function_version_info and cgraph_node for DECL. This
1239 DECL is a duplicate declaration. */
1240 static void delete_function_version (tree decl);
1241
1242 /* Add the function FNDECL to the call graph.
3dafb85c 1243 Unlike finalize_function, this function is intended to be used
d52f5295
ML
1244 by middle end and allows insertion of new function at arbitrary point
1245 of compilation. The function can be either in high, low or SSA form
1246 GIMPLE.
1247
1248 The function is assumed to be reachable and have address taken (so no
1249 API breaking optimizations are performed on it).
1250
1251 Main work done by this function is to enqueue the function for later
1252 processing to avoid need the passes to be re-entrant. */
1253 static void add_new_function (tree fndecl, bool lowered);
1254
1255 /* Return callgraph node for given symbol and check it is a function. */
1256 static inline cgraph_node *get (const_tree decl)
1257 {
1258 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL);
1259 return dyn_cast <cgraph_node *> (symtab_node::get (decl));
1260 }
1261
3dafb85c
ML
1262 /* DECL has been parsed. Take it, queue it, compile it at the whim of the
1263 logic in effect. If NO_COLLECT is true, then our caller cannot stand to
1264 have the garbage collector run at the moment. We would need to either
1265 create a new GC context, or just not compile right now. */
1266 static void finalize_function (tree, bool);
1267
d52f5295
ML
1268 /* Return cgraph node assigned to DECL. Create new one when needed. */
1269 static cgraph_node * create (tree decl);
1270
d52f5295
ML
1271 /* Try to find a call graph node for declaration DECL and if it does not
1272 exist or if it corresponds to an inline clone, create a new one. */
1273 static cgraph_node * get_create (tree);
1274
3dafb85c
ML
1275 /* Return local info for the compiled function. */
1276 static cgraph_local_info *local_info (tree decl);
1277
3dafb85c 1278 /* Return local info for the compiled function. */
88f554b4 1279 static struct cgraph_rtl_info *rtl_info (tree);
3dafb85c 1280
d52f5295
ML
1281 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
1282 Return NULL if there's no such node. */
1283 static cgraph_node *get_for_asmname (tree asmname);
1284
1285 /* Attempt to mark ALIAS as an alias to DECL. Return alias node if
1286 successful and NULL otherwise.
1287 Same body aliases are output whenever the body of DECL is output,
1288 and cgraph_node::get (ALIAS) transparently
1289 returns cgraph_node::get (DECL). */
1290 static cgraph_node * create_same_body_alias (tree alias, tree decl);
1291
d52f5295
ML
1292 /* Verify whole cgraph structure. */
1293 static void DEBUG_FUNCTION verify_cgraph_nodes (void);
1294
b2b29377
MM
1295 /* Verify cgraph, if consistency checking is enabled. */
1296 static inline void checking_verify_cgraph_nodes (void);
1297
d52f5295
ML
1298 /* Worker to bring NODE local. */
1299 static bool make_local (cgraph_node *node, void *);
1300
1301 /* Mark ALIAS as an alias to DECL. DECL_NODE is cgraph node representing
1302 the function body is associated
1303 with (not necessarily cgraph_node (DECL). */
1304 static cgraph_node *create_alias (tree alias, tree target);
1305
17d1bf76
ML
1306 /* Return true if NODE has thunk. */
1307 static bool has_thunk_p (cgraph_node *node, void *);
1308
3dafb85c
ML
1309 cgraph_edge *callees;
1310 cgraph_edge *callers;
e33c6cd6
MJ
1311 /* List of edges representing indirect calls with a yet undetermined
1312 callee. */
3dafb85c 1313 cgraph_edge *indirect_calls;
1c4a429a 1314 /* For nested functions points to function the node is nested in. */
d52f5295 1315 cgraph_node *origin;
1c4a429a 1316 /* Points to first nested function, if any. */
d52f5295 1317 cgraph_node *nested;
1c4a429a 1318 /* Pointer to the next function with same origin, if any. */
d52f5295 1319 cgraph_node *next_nested;
18c6ada9 1320 /* Pointer to the next clone. */
d52f5295
ML
1321 cgraph_node *next_sibling_clone;
1322 cgraph_node *prev_sibling_clone;
1323 cgraph_node *clones;
1324 cgraph_node *clone_of;
d5e254e1
IE
1325 /* If instrumentation_clone is 1 then instrumented_version points
1326 to the original function used to make instrumented version.
1327 Otherwise points to instrumented version of the function. */
1328 cgraph_node *instrumented_version;
1329 /* If instrumentation_clone is 1 then orig_decl is the original
1330 function declaration. */
1331 tree orig_decl;
70d539ce
JH
1332 /* For functions with many calls sites it holds map from call expression
1333 to the edge to speed up cgraph_edge function. */
2a22f99c 1334 hash_table<cgraph_edge_hasher> *GTY(()) call_site_hash;
97ba0040
JH
1335 /* Declaration node used to be clone of. */
1336 tree former_clone_of;
c22cacf3 1337
0136f8f0
AH
1338 /* If this is a SIMD clone, this points to the SIMD specific
1339 information for it. */
3dafb85c 1340 cgraph_simd_clone *simdclone;
0136f8f0 1341 /* If this function has SIMD clones, this points to the first clone. */
d52f5295 1342 cgraph_node *simd_clones;
0136f8f0 1343
0e3776db
JH
1344 /* Interprocedural passes scheduled to have their transform functions
1345 applied next time we execute local pass on them. We maintain it
1346 per-function in order to allow IPA passes to introduce new functions. */
9771b263 1347 vec<ipa_opt_pass> GTY((skip)) ipa_transforms_to_apply;
0e3776db 1348
3dafb85c
ML
1349 cgraph_local_info local;
1350 cgraph_global_info global;
88f554b4 1351 struct cgraph_rtl_info *rtl;
3dafb85c
ML
1352 cgraph_clone_info clone;
1353 cgraph_thunk_info thunk;
c22cacf3 1354
e42922b1
JH
1355 /* Expected number of executions: calculated in profile.c. */
1356 gcov_type count;
db0bf14f
JH
1357 /* How to scale counts at materialization time; used to merge
1358 LTO units with different number of profile runs. */
1359 int count_materialization_scale;
95c755e9
JH
1360 /* Unique id of the node. */
1361 int uid;
4008290f
ML
1362 /* Summary unique id of the node. */
1363 int summary_uid;
2fa3d31b
JH
1364 /* ID assigned by the profiling. */
1365 unsigned int profile_id;
86ce5d2f
ML
1366 /* Time profiler: first run of function. */
1367 int tp_first_run;
3691626c 1368
6b20f353
DS
1369 /* Set when decl is an abstract function pointed to by the
1370 ABSTRACT_DECL_ORIGIN of a reachable function. */
c0c123ef 1371 unsigned used_as_abstract_origin : 1;
50674e96 1372 /* Set once the function is lowered (i.e. its CFG is built). */
b4e19405 1373 unsigned lowered : 1;
25c84396
RH
1374 /* Set once the function has been instantiated and its callee
1375 lists created. */
257eb6e3 1376 unsigned process : 1;
5fefcf92
JH
1377 /* How commonly executed the node is. Initialized during branch
1378 probabilities pass. */
1379 ENUM_BITFIELD (node_frequency) frequency : 2;
844db5d0
JH
1380 /* True when function can only be called at startup (from static ctor). */
1381 unsigned only_called_at_startup : 1;
1382 /* True when function can only be called at startup (from static dtor). */
1383 unsigned only_called_at_exit : 1;
0a35513e
AH
1384 /* True when function is the transactional clone of a function which
1385 is called only from inside transactions. */
1386 /* ?? We should be able to remove this. We have enough bits in
1387 cgraph to calculate it. */
1388 unsigned tm_clone : 1;
3649b9b7
ST
1389 /* True if this decl is a dispatcher for function versions. */
1390 unsigned dispatcher_function : 1;
1f26ac87
JM
1391 /* True if this decl calls a COMDAT-local function. This is set up in
1392 compute_inline_parameters and inline_call. */
1393 unsigned calls_comdat_local : 1;
b84d4347
ML
1394 /* True if node has been created by merge operation in IPA-ICF. */
1395 unsigned icf_merged: 1;
d5e254e1
IE
1396 /* True when function is clone created for Pointer Bounds Checker
1397 instrumentation. */
1398 unsigned instrumentation_clone : 1;
8413ca87
JJ
1399 /* True if call to node can't result in a call to free, munmap or
1400 other operation that could make previously non-trapping memory
1401 accesses trapping. */
1402 unsigned nonfreeing_fn : 1;
ebc8f0bb 1403 /* True if there was multiple COMDAT bodies merged by lto-symtab. */
88636b62 1404 unsigned merged_comdat : 1;
a79b7ec5
TV
1405 /* True if function was created to be executed in parallel. */
1406 unsigned parallelized_function : 1;
41f669d8
JH
1407 /* True if function is part split out by ipa-split. */
1408 unsigned split_part : 1;
4f4ada6a
JH
1409 /* True if the function appears as possible target of indirect call. */
1410 unsigned indirect_call_target : 1;
31de7606
JH
1411
1412private:
1413 /* Worker for call_for_symbol_and_aliases. */
1414 bool call_for_symbol_and_aliases_1 (bool (*callback) (cgraph_node *,
1415 void *),
1416 void *data, bool include_overwritable);
3649b9b7
ST
1417};
1418
fed5ae11
DK
1419/* A cgraph node set is a collection of cgraph nodes. A cgraph node
1420 can appear in multiple sets. */
1cb1a99f 1421struct cgraph_node_set_def
fed5ae11 1422{
b787e7a2 1423 hash_map<cgraph_node *, size_t> *map;
d52f5295 1424 vec<cgraph_node *> nodes;
fed5ae11
DK
1425};
1426
d52f5295
ML
1427typedef cgraph_node_set_def *cgraph_node_set;
1428typedef struct varpool_node_set_def *varpool_node_set;
2942c502 1429
d52f5295 1430class varpool_node;
2942c502
JH
1431
1432/* A varpool node set is a collection of varpool nodes. A varpool node
1433 can appear in multiple sets. */
1cb1a99f 1434struct varpool_node_set_def
2942c502 1435{
b787e7a2 1436 hash_map<varpool_node *, size_t> * map;
d52f5295 1437 vec<varpool_node *> nodes;
2942c502
JH
1438};
1439
fed5ae11 1440/* Iterator structure for cgraph node sets. */
84562394 1441struct cgraph_node_set_iterator
fed5ae11
DK
1442{
1443 cgraph_node_set set;
1444 unsigned index;
84562394 1445};
fed5ae11 1446
2942c502 1447/* Iterator structure for varpool node sets. */
84562394 1448struct varpool_node_set_iterator
2942c502
JH
1449{
1450 varpool_node_set set;
1451 unsigned index;
84562394 1452};
2942c502 1453
ba392339
JH
1454/* Context of polymorphic call. It represent information about the type of
1455 instance that may reach the call. This is used by ipa-devirt walkers of the
1456 type inheritance graph. */
1457
1458class GTY(()) ipa_polymorphic_call_context {
1459public:
1460 /* The called object appears in an object of type OUTER_TYPE
1461 at offset OFFSET. When information is not 100% reliable, we
1462 use SPECULATIVE_OUTER_TYPE and SPECULATIVE_OFFSET. */
1463 HOST_WIDE_INT offset;
1464 HOST_WIDE_INT speculative_offset;
1465 tree outer_type;
1466 tree speculative_outer_type;
1467 /* True if outer object may be in construction or destruction. */
4081ada2 1468 unsigned maybe_in_construction : 1;
ba392339 1469 /* True if outer object may be of derived type. */
4081ada2 1470 unsigned maybe_derived_type : 1;
ba392339
JH
1471 /* True if speculative outer object may be of derived type. We always
1472 speculate that construction does not happen. */
4081ada2 1473 unsigned speculative_maybe_derived_type : 1;
ba392339
JH
1474 /* True if the context is invalid and all calls should be redirected
1475 to BUILTIN_UNREACHABLE. */
4081ada2
JH
1476 unsigned invalid : 1;
1477 /* True if the outer type is dynamic. */
1478 unsigned dynamic : 1;
ba392339
JH
1479
1480 /* Build empty "I know nothing" context. */
1481 ipa_polymorphic_call_context ();
1482 /* Build polymorphic call context for indirect call E. */
1483 ipa_polymorphic_call_context (cgraph_edge *e);
1484 /* Build polymorphic call context for IP invariant CST.
1485 If specified, OTR_TYPE specify the type of polymorphic call
1486 that takes CST+OFFSET as a prameter. */
1487 ipa_polymorphic_call_context (tree cst, tree otr_type = NULL,
1488 HOST_WIDE_INT offset = 0);
1489 /* Build context for pointer REF contained in FNDECL at statement STMT.
1490 if INSTANCE is non-NULL, return pointer to the object described by
1491 the context. */
355fe088 1492 ipa_polymorphic_call_context (tree fndecl, tree ref, gimple *stmt,
ba392339
JH
1493 tree *instance = NULL);
1494
1495 /* Look for vtable stores or constructor calls to work out dynamic type
1496 of memory location. */
355fe088 1497 bool get_dynamic_type (tree, tree, tree, gimple *);
ba392339
JH
1498
1499 /* Make context non-speculative. */
1500 void clear_speculation ();
1501
6ff65dd7
MJ
1502 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
1503 NULL, the context is set to dummy "I know nothing" setting. */
1504 void clear_outer_type (tree otr_type = NULL);
1505
ba392339 1506 /* Walk container types and modify context to point to actual class
67a1b94c
JH
1507 containing OTR_TYPE (if non-NULL) as base class.
1508 Return true if resulting context is valid.
1509
1510 When CONSIDER_PLACEMENT_NEW is false, reject contexts that may be made
5764ee3c 1511 valid only via allocation of new polymorphic type inside by means
67a1b94c
JH
1512 of placement new.
1513
1514 When CONSIDER_BASES is false, only look for actual fields, not base types
1515 of TYPE. */
1516 bool restrict_to_inner_class (tree otr_type,
1517 bool consider_placement_new = true,
1518 bool consider_bases = true);
1519
1520 /* Adjust all offsets in contexts by given number of bits. */
1521 void offset_by (HOST_WIDE_INT);
4081ada2
JH
1522 /* Use when we can not track dynamic type change. This speculatively assume
1523 type change is not happening. */
f9bb202b 1524 void possible_dynamic_type_change (bool, tree otr_type = NULL);
67a1b94c
JH
1525 /* Assume that both THIS and a given context is valid and strenghten THIS
1526 if possible. Return true if any strenghtening was made.
1527 If actual type the context is being used in is known, OTR_TYPE should be
1528 set accordingly. This improves quality of combined result. */
1529 bool combine_with (ipa_polymorphic_call_context, tree otr_type = NULL);
df0d8136 1530 bool meet_with (ipa_polymorphic_call_context, tree otr_type = NULL);
67a1b94c
JH
1531
1532 /* Return TRUE if context is fully useless. */
1533 bool useless_p () const;
44210a96
MJ
1534 /* Return TRUE if this context conveys the same information as X. */
1535 bool equal_to (const ipa_polymorphic_call_context &x) const;
ba392339 1536
44210a96
MJ
1537 /* Dump human readable context to F. If NEWLINE is true, it will be
1538 terminated by a newline. */
1539 void dump (FILE *f, bool newline = true) const;
ba392339
JH
1540 void DEBUG_FUNCTION debug () const;
1541
1542 /* LTO streaming. */
1543 void stream_out (struct output_block *) const;
1544 void stream_in (struct lto_input_block *, struct data_in *data_in);
1545
1546private:
67a1b94c 1547 bool combine_speculation_with (tree, HOST_WIDE_INT, bool, tree);
df0d8136 1548 bool meet_speculation_with (tree, HOST_WIDE_INT, bool, tree);
ba392339
JH
1549 void set_by_decl (tree, HOST_WIDE_INT);
1550 bool set_by_invariant (tree, tree, HOST_WIDE_INT);
df0d8136 1551 bool speculation_consistent_p (tree, HOST_WIDE_INT, bool, tree) const;
4081ada2 1552 void make_speculative (tree otr_type = NULL);
ba392339
JH
1553};
1554
e33c6cd6
MJ
1555/* Structure containing additional information about an indirect call. */
1556
1557struct GTY(()) cgraph_indirect_call_info
1558{
ba392339
JH
1559 /* When agg_content is set, an offset where the call pointer is located
1560 within the aggregate. */
1561 HOST_WIDE_INT offset;
1562 /* Context of the polymorphic call; use only when POLYMORPHIC flag is set. */
1563 ipa_polymorphic_call_context context;
b258210c
MJ
1564 /* OBJ_TYPE_REF_TOKEN of a polymorphic call (if polymorphic is set). */
1565 HOST_WIDE_INT otr_token;
1566 /* Type of the object from OBJ_TYPE_REF_OBJECT. */
ba392339 1567 tree otr_type;
e33c6cd6
MJ
1568 /* Index of the parameter that is called. */
1569 int param_index;
5f902d76
JH
1570 /* ECF flags determined from the caller. */
1571 int ecf_flags;
634ab819
JH
1572 /* Profile_id of common target obtrained from profile. */
1573 int common_target_id;
1574 /* Probability that call will land in function with COMMON_TARGET_ID. */
1575 int common_target_probability;
b258210c
MJ
1576
1577 /* Set when the call is a virtual call with the parameter being the
1578 associated object pointer rather than a simple direct call. */
1579 unsigned polymorphic : 1;
8b7773a4
MJ
1580 /* Set when the call is a call of a pointer loaded from contents of an
1581 aggregate at offset. */
1582 unsigned agg_contents : 1;
c13bc3d9
MJ
1583 /* Set when this is a call through a member pointer. */
1584 unsigned member_ptr : 1;
91bb9f80
MJ
1585 /* When the agg_contents bit is set, this one determines whether the
1586 destination is loaded from a parameter passed by reference. */
8b7773a4 1587 unsigned by_ref : 1;
91bb9f80
MJ
1588 /* When the agg_contents bit is set, this one determines whether we can
1589 deduce from the function body that the loaded value from the reference is
1590 never modified between the invocation of the function and the load
1591 point. */
1592 unsigned guaranteed_unmodified : 1;
0127c169
JH
1593 /* For polymorphic calls this specify whether the virtual table pointer
1594 may have changed in between function entry and the call. */
1595 unsigned vptr_changed : 1;
e33c6cd6
MJ
1596};
1597
2a22f99c
TS
1598struct GTY((chain_next ("%h.next_caller"), chain_prev ("%h.prev_caller"),
1599 for_user)) cgraph_edge {
3dafb85c
ML
1600 friend class cgraph_node;
1601
1602 /* Remove the edge in the cgraph. */
1603 void remove (void);
1604
1605 /* Change field call_stmt of edge to NEW_STMT.
1606 If UPDATE_SPECULATIVE and E is any component of speculative
1607 edge, then update all components. */
538dd0b7 1608 void set_call_stmt (gcall *new_stmt, bool update_speculative = true);
3dafb85c
ML
1609
1610 /* Redirect callee of the edge to N. The function does not update underlying
1611 call expression. */
1612 void redirect_callee (cgraph_node *n);
1613
6a4bad95
MJ
1614 /* If the edge does not lead to a thunk, simply redirect it to N. Otherwise
1615 create one or more equivalent thunks for N and redirect E to the first in
1616 the chain. Note that it is then necessary to call
1617 n->expand_all_artificial_thunks once all callers are redirected. */
1618 void redirect_callee_duplicating_thunks (cgraph_node *n);
1619
3dafb85c
ML
1620 /* Make an indirect edge with an unknown callee an ordinary edge leading to
1621 CALLEE. DELTA is an integer constant that is to be added to the this
1622 pointer (first parameter) to compensate for skipping
1623 a thunk adjustment. */
1624 cgraph_edge *make_direct (cgraph_node *callee);
1625
1626 /* Turn edge into speculative call calling N2. Update
1627 the profile so the direct call is taken COUNT times
1628 with FREQUENCY. */
1629 cgraph_edge *make_speculative (cgraph_node *n2, gcov_type direct_count,
1630 int direct_frequency);
1631
1632 /* Given speculative call edge, return all three components. */
1633 void speculative_call_info (cgraph_edge *&direct, cgraph_edge *&indirect,
1634 ipa_ref *&reference);
1635
1636 /* Speculative call edge turned out to be direct call to CALLE_DECL.
1637 Remove the speculative call sequence and return edge representing the call.
1638 It is up to caller to redirect the call as appropriate. */
1639 cgraph_edge *resolve_speculation (tree callee_decl = NULL);
1640
1641 /* If necessary, change the function declaration in the call statement
1642 associated with the edge so that it corresponds to the edge callee. */
355fe088 1643 gimple *redirect_call_stmt_to_callee (void);
3dafb85c
ML
1644
1645 /* Create clone of edge in the node N represented
1646 by CALL_EXPR the callgraph. */
538dd0b7 1647 cgraph_edge * clone (cgraph_node *n, gcall *call_stmt, unsigned stmt_uid,
3dafb85c
ML
1648 gcov_type count_scale, int freq_scale, bool update_original);
1649
90988f77
ML
1650 /* Verify edge count and frequency. */
1651 bool verify_count_and_frequency ();
1652
3dafb85c
ML
1653 /* Return true when call of edge can not lead to return from caller
1654 and thus it is safe to ignore its side effects for IPA analysis
1655 when computing side effects of the caller. */
1656 bool cannot_lead_to_return_p (void);
1657
1658 /* Return true when the edge represents a direct recursion. */
1659 bool recursive_p (void);
1660
1661 /* Return true if the call can be hot. */
1662 bool maybe_hot_p (void);
1663
1664 /* Rebuild cgraph edges for current function node. This needs to be run after
1665 passes that don't update the cgraph. */
1666 static unsigned int rebuild_edges (void);
1667
1668 /* Rebuild cgraph references for current function node. This needs to be run
1669 after passes that don't update the cgraph. */
1670 static void rebuild_references (void);
1671
6009ee7b
MJ
1672 /* Expected number of executions: calculated in profile.c. */
1673 gcov_type count;
d52f5295
ML
1674 cgraph_node *caller;
1675 cgraph_node *callee;
3dafb85c
ML
1676 cgraph_edge *prev_caller;
1677 cgraph_edge *next_caller;
1678 cgraph_edge *prev_callee;
1679 cgraph_edge *next_callee;
538dd0b7 1680 gcall *call_stmt;
e33c6cd6
MJ
1681 /* Additional information about an indirect call. Not cleared when an edge
1682 becomes direct. */
3dafb85c 1683 cgraph_indirect_call_info *indirect_info;
18c6ada9 1684 PTR GTY ((skip (""))) aux;
61a05df1
JH
1685 /* When equal to CIF_OK, inline this call. Otherwise, points to the
1686 explanation why function was not inlined. */
84562394 1687 enum cgraph_inline_failed_t inline_failed;
6009ee7b
MJ
1688 /* The stmt_uid of call_stmt. This is used by LTO to recover the call_stmt
1689 when the function is serialized in. */
1690 unsigned int lto_stmt_uid;
b8698a0f 1691 /* Expected frequency of executions within the function.
45a80bb9
JH
1692 When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
1693 per function call. The range is 0 to CGRAPH_FREQ_MAX. */
1694 int frequency;
6009ee7b
MJ
1695 /* Unique id of the edge. */
1696 int uid;
e33c6cd6
MJ
1697 /* Whether this edge was made direct by indirect inlining. */
1698 unsigned int indirect_inlining_edge : 1;
1699 /* Whether this edge describes an indirect call with an undetermined
1700 callee. */
1701 unsigned int indirect_unknown_callee : 1;
1702 /* Whether this edge is still a dangling */
d7f09764
DN
1703 /* True if the corresponding CALL stmt cannot be inlined. */
1704 unsigned int call_stmt_cannot_inline_p : 1;
2505c5ed
JH
1705 /* Can this call throw externally? */
1706 unsigned int can_throw_external : 1;
042ae7d2
JH
1707 /* Edges with SPECULATIVE flag represents indirect calls that was
1708 speculatively turned into direct (i.e. by profile feedback).
1709 The final code sequence will have form:
1710
1711 if (call_target == expected_fn)
1712 expected_fn ();
1713 else
1714 call_target ();
1715
1716 Every speculative call is represented by three components attached
1717 to a same call statement:
1718 1) a direct call (to expected_fn)
1719 2) an indirect call (to call_target)
1720 3) a IPA_REF_ADDR refrence to expected_fn.
1721
1722 Optimizers may later redirect direct call to clone, so 1) and 3)
1723 do not need to necesarily agree with destination. */
1724 unsigned int speculative : 1;
f9bb202b
JH
1725 /* Set to true when caller is a constructor or destructor of polymorphic
1726 type. */
1727 unsigned in_polymorphic_cdtor : 1;
3dafb85c 1728
f13fe18b
JH
1729 /* Return true if call must bind to current definition. */
1730 bool binds_to_current_def_p ();
1731
3dafb85c
ML
1732private:
1733 /* Remove the edge from the list of the callers of the callee. */
1734 void remove_caller (void);
1735
1736 /* Remove the edge from the list of the callees of the caller. */
1737 void remove_callee (void);
90988f77
ML
1738
1739 /* Set callee N of call graph edge and add it to the corresponding set of
1740 callers. */
1741 void set_callee (cgraph_node *n);
1742
1743 /* Output flags of edge to a file F. */
1744 void dump_edge_flags (FILE *f);
1745
1746 /* Verify that call graph edge corresponds to DECL from the associated
1747 statement. Return true if the verification should fail. */
1748 bool verify_corresponds_to_fndecl (tree decl);
1c4a429a
JH
1749};
1750
45a80bb9
JH
1751#define CGRAPH_FREQ_BASE 1000
1752#define CGRAPH_FREQ_MAX 100000
1753
8a4a83ed
JH
1754/* The varpool data structure.
1755 Each static variable decl has assigned varpool_node. */
e69529cd 1756
5e20cdc9 1757class GTY((tag ("SYMTAB_VARIABLE"))) varpool_node : public symtab_node {
a3bfa8b8 1758public:
9041d2e6
ML
1759 /* Dump given varpool node to F. */
1760 void dump (FILE *f);
1761
1762 /* Dump given varpool node to stderr. */
1763 void DEBUG_FUNCTION debug (void);
1764
1765 /* Remove variable from symbol table. */
1766 void remove (void);
1767
1768 /* Remove node initializer when it is no longer needed. */
1769 void remove_initializer (void);
1770
1771 void analyze (void);
1772
1773 /* Return variable availability. */
f13fe18b 1774 availability get_availability (symtab_node *ref = NULL);
9041d2e6
ML
1775
1776 /* When doing LTO, read variable's constructor from disk if
1777 it is not already present. */
1778 tree get_constructor (void);
1779
1780 /* Return true if variable has constructor that can be used for folding. */
1781 bool ctor_useable_for_folding_p (void);
1782
1783 /* For given variable pool node, walk the alias chain to return the function
1784 the variable is alias of. Do not walk through thunks.
f13fe18b
JH
1785 When AVAILABILITY is non-NULL, get minimal availability in the chain.
1786 When REF is non-NULL, assume that reference happens in symbol REF
1787 when determining the availability. */
9041d2e6 1788 inline varpool_node *ultimate_alias_target
f13fe18b 1789 (availability *availability = NULL, symtab_node *ref = NULL);
9041d2e6
ML
1790
1791 /* Return node that alias is aliasing. */
1792 inline varpool_node *get_alias_target (void);
1793
1794 /* Output one variable, if necessary. Return whether we output it. */
1795 bool assemble_decl (void);
1796
1797 /* For variables in named sections make sure get_variable_section
1798 is called before we switch to those sections. Then section
1799 conflicts between read-only and read-only requiring relocations
1800 sections can be resolved. */
1801 void finalize_named_section_flags (void);
1802
1803 /* Call calback on varpool symbol and aliases associated to varpool symbol.
1804 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1805 skipped. */
31de7606
JH
1806 bool call_for_symbol_and_aliases (bool (*callback) (varpool_node *, void *),
1807 void *data,
1808 bool include_overwritable);
9041d2e6
ML
1809
1810 /* Return true when variable should be considered externally visible. */
1811 bool externally_visible_p (void);
1812
1813 /* Return true when all references to variable must be visible
1814 in ipa_ref_list.
1815 i.e. if the variable is not externally visible or not used in some magic
1816 way (asm statement or such).
1817 The magic uses are all summarized in force_output flag. */
1818 inline bool all_refs_explicit_p ();
1819
1820 /* Return true when variable can be removed from variable pool
1821 if all direct calls are eliminated. */
1822 inline bool can_remove_if_no_refs_p (void);
1823
3dafb85c
ML
1824 /* Add the variable DECL to the varpool.
1825 Unlike finalize_decl function is intended to be used
1826 by middle end and allows insertion of new variable at arbitrary point
1827 of compilation. */
1828 static void add (tree decl);
1829
9041d2e6
ML
1830 /* Return varpool node for given symbol and check it is a function. */
1831 static inline varpool_node *get (const_tree decl);
1832
1833 /* Mark DECL as finalized. By finalizing the declaration, frontend instruct
1834 the middle end to output the variable to asm file, if needed or externally
1835 visible. */
1836 static void finalize_decl (tree decl);
1837
9041d2e6
ML
1838 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1839 Extra name aliases are output whenever DECL is output. */
1840 static varpool_node * create_extra_name_alias (tree alias, tree decl);
1841
1842 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1843 Extra name aliases are output whenever DECL is output. */
1844 static varpool_node * create_alias (tree, tree);
1845
1846 /* Dump the variable pool to F. */
1847 static void dump_varpool (FILE *f);
1848
1849 /* Dump the variable pool to stderr. */
1850 static void DEBUG_FUNCTION debug_varpool (void);
1851
1852 /* Allocate new callgraph node and insert it into basic data structures. */
1853 static varpool_node *create_empty (void);
1854
1855 /* Return varpool node assigned to DECL. Create new one when needed. */
1856 static varpool_node *get_create (tree decl);
1857
1858 /* Given an assembler name, lookup node. */
1859 static varpool_node *get_for_asmname (tree asmname);
1860
6b02a499 1861 /* Set when variable is scheduled to be assembled. */
b4e19405 1862 unsigned output : 1;
eb1d8159 1863
d5e254e1
IE
1864 /* Set when variable has statically initialized pointer
1865 or is a static bounds variable and needs initalization. */
1866 unsigned need_bounds_init : 1;
1867
59b36ecf
JJ
1868 /* Set if the variable is dynamically initialized, except for
1869 function local statics. */
1870 unsigned dynamically_initialized : 1;
56363ffd
JH
1871
1872 ENUM_BITFIELD(tls_model) tls_model : 3;
eb6a09a7
JH
1873
1874 /* Set if the variable is known to be used by single function only.
1875 This is computed by ipa_signle_use pass and used by late optimizations
1876 in places where optimization would be valid for local static variable
1877 if we did not do any inter-procedural code movement. */
1878 unsigned used_by_single_function : 1;
d52f5295 1879
9041d2e6
ML
1880private:
1881 /* Assemble thunks and aliases associated to varpool node. */
1882 void assemble_aliases (void);
31de7606
JH
1883
1884 /* Worker for call_for_node_and_aliases. */
1885 bool call_for_symbol_and_aliases_1 (bool (*callback) (varpool_node *, void *),
1886 void *data,
1887 bool include_overwritable);
e69529cd
JH
1888};
1889
65d630d4 1890/* Every top level asm statement is put into a asm_node. */
474eccc6 1891
65d630d4 1892struct GTY(()) asm_node {
3dafb85c
ML
1893
1894
474eccc6 1895 /* Next asm node. */
3dafb85c 1896 asm_node *next;
474eccc6
ILT
1897 /* String for this asm node. */
1898 tree asm_str;
1899 /* Ordering of all cgraph nodes. */
1900 int order;
1901};
1902
5d59b5e1
LC
1903/* Report whether or not THIS symtab node is a function, aka cgraph_node. */
1904
1905template <>
1906template <>
1907inline bool
7de90a6c 1908is_a_helper <cgraph_node *>::test (symtab_node *p)
5d59b5e1 1909{
d52f5295 1910 return p && p->type == SYMTAB_FUNCTION;
5d59b5e1
LC
1911}
1912
1913/* Report whether or not THIS symtab node is a vriable, aka varpool_node. */
1914
1915template <>
1916template <>
1917inline bool
7de90a6c 1918is_a_helper <varpool_node *>::test (symtab_node *p)
5d59b5e1 1919{
d52f5295 1920 return p && p->type == SYMTAB_VARIABLE;
5d59b5e1
LC
1921}
1922
3dafb85c
ML
1923/* Macros to access the next item in the list of free cgraph nodes and
1924 edges. */
1925#define NEXT_FREE_NODE(NODE) dyn_cast<cgraph_node *> ((NODE)->next)
1926#define SET_NEXT_FREE_NODE(NODE,NODE2) ((NODE))->next = NODE2
1927#define NEXT_FREE_EDGE(EDGE) (EDGE)->prev_caller
1928
1929typedef void (*cgraph_edge_hook)(cgraph_edge *, void *);
1930typedef void (*cgraph_node_hook)(cgraph_node *, void *);
1931typedef void (*varpool_node_hook)(varpool_node *, void *);
1932typedef void (*cgraph_2edge_hook)(cgraph_edge *, cgraph_edge *, void *);
1933typedef void (*cgraph_2node_hook)(cgraph_node *, cgraph_node *, void *);
1934
1935struct cgraph_edge_hook_list;
1936struct cgraph_node_hook_list;
1937struct varpool_node_hook_list;
1938struct cgraph_2edge_hook_list;
1939struct cgraph_2node_hook_list;
1940
1941/* Map from a symbol to initialization/finalization priorities. */
1942struct GTY(()) symbol_priority_map {
3dafb85c
ML
1943 priority_type init;
1944 priority_type fini;
1945};
1946
1947enum symtab_state
f45e0ad1 1948{
66058468 1949 /* Frontend is parsing and finalizing functions. */
3dafb85c 1950 PARSING,
f45e0ad1 1951 /* Callgraph is being constructed. It is safe to add new functions. */
3dafb85c 1952 CONSTRUCTION,
17e0fc92 1953 /* Callgraph is being streamed-in at LTO time. */
3dafb85c 1954 LTO_STREAMING,
17e0fc92 1955 /* Callgraph is built and early IPA passes are being run. */
3dafb85c 1956 IPA,
7a388ee4 1957 /* Callgraph is built and all functions are transformed to SSA form. */
3dafb85c 1958 IPA_SSA,
17e0fc92
JH
1959 /* All inline decisions are done; it is now possible to remove extern inline
1960 functions and virtual call targets. */
1961 IPA_SSA_AFTER_INLINING,
f45e0ad1 1962 /* Functions are now ordered and being passed to RTL expanders. */
3dafb85c 1963 EXPANSION,
f45e0ad1 1964 /* All cgraph expansion is done. */
3dafb85c 1965 FINISHED
f45e0ad1 1966};
1c4a429a 1967
7edd9b15 1968struct asmname_hasher : ggc_ptr_hash <symtab_node>
2a22f99c 1969{
2a22f99c 1970 typedef const_tree compare_type;
2a22f99c
TS
1971
1972 static hashval_t hash (symtab_node *n);
1973 static bool equal (symtab_node *n, const_tree t);
2a22f99c
TS
1974};
1975
3dafb85c
ML
1976class GTY((tag ("SYMTAB"))) symbol_table
1977{
1978public:
1979 friend class symtab_node;
1980 friend class cgraph_node;
1981 friend class cgraph_edge;
1982
4008290f
ML
1983 symbol_table (): cgraph_max_summary_uid (1)
1984 {
1985 }
1986
3dafb85c 1987 /* Initialize callgraph dump file. */
c582198b 1988 void initialize (void);
3dafb85c
ML
1989
1990 /* Register a top-level asm statement ASM_STR. */
1991 inline asm_node *finalize_toplevel_asm (tree asm_str);
1992
1993 /* Analyze the whole compilation unit once it is parsed completely. */
1994 void finalize_compilation_unit (void);
1995
1996 /* C++ frontend produce same body aliases all over the place, even before PCH
1997 gets streamed out. It relies on us linking the aliases with their function
1998 in order to do the fixups, but ipa-ref is not PCH safe. Consequentely we
1999 first produce aliases without links, but once C++ FE is sure he won't sream
2000 PCH we build the links via this function. */
2001 void process_same_body_aliases (void);
2002
2003 /* Perform simple optimizations based on callgraph. */
2004 void compile (void);
2005
2006 /* Process CGRAPH_NEW_FUNCTIONS and perform actions necessary to add these
2007 functions into callgraph in a way so they look like ordinary reachable
2008 functions inserted into callgraph already at construction time. */
2009 void process_new_functions (void);
2010
2011 /* Once all functions from compilation unit are in memory, produce all clones
2012 and update all calls. We might also do this on demand if we don't want to
2013 bring all functions to memory prior compilation, but current WHOPR
026c3cfd 2014 implementation does that and it is bit easier to keep everything right
3dafb85c
ML
2015 in this order. */
2016 void materialize_all_clones (void);
2017
2018 /* Register a symbol NODE. */
2019 inline void register_symbol (symtab_node *node);
2020
2021 inline void
2022 clear_asm_symbols (void)
2023 {
2024 asmnodes = NULL;
2025 asm_last_node = NULL;
2026 }
2027
2028 /* Perform reachability analysis and reclaim all unreachable nodes. */
17e0fc92 2029 bool remove_unreachable_nodes (FILE *file);
3dafb85c
ML
2030
2031 /* Optimization of function bodies might've rendered some variables as
2032 unnecessary so we want to avoid these from being compiled. Re-do
2033 reachability starting from variables that are either externally visible
2034 or was referred from the asm output routines. */
2035 void remove_unreferenced_decls (void);
2036
2037 /* Unregister a symbol NODE. */
2038 inline void unregister (symtab_node *node);
2039
2040 /* Allocate new callgraph node and insert it into basic data structures. */
2041 cgraph_node *create_empty (void);
2042
2043 /* Release a callgraph NODE with UID and put in to the list
2044 of free nodes. */
2045 void release_symbol (cgraph_node *node, int uid);
2046
2047 /* Output all variables enqueued to be assembled. */
2048 bool output_variables (void);
2049
3dafb85c
ML
2050 /* Weakrefs may be associated to external decls and thus not output
2051 at expansion time. Emit all necessary aliases. */
2052 void output_weakrefs (void);
2053
2054 /* Return first static symbol with definition. */
2055 inline symtab_node *first_symbol (void);
2056
2057 /* Return first assembler symbol. */
2058 inline asm_node *
2059 first_asm_symbol (void)
2060 {
2061 return asmnodes;
2062 }
2063
2064 /* Return first static symbol with definition. */
2065 inline symtab_node *first_defined_symbol (void);
2066
2067 /* Return first variable. */
2068 inline varpool_node *first_variable (void);
2069
2070 /* Return next variable after NODE. */
2071 inline varpool_node *next_variable (varpool_node *node);
2072
2073 /* Return first static variable with initializer. */
2074 inline varpool_node *first_static_initializer (void);
2075
2076 /* Return next static variable with initializer after NODE. */
2077 inline varpool_node *next_static_initializer (varpool_node *node);
2078
2079 /* Return first static variable with definition. */
2080 inline varpool_node *first_defined_variable (void);
2081
2082 /* Return next static variable with definition after NODE. */
2083 inline varpool_node *next_defined_variable (varpool_node *node);
2084
2085 /* Return first function with body defined. */
2086 inline cgraph_node *first_defined_function (void);
2087
2088 /* Return next function with body defined after NODE. */
2089 inline cgraph_node *next_defined_function (cgraph_node *node);
2090
2091 /* Return first function. */
2092 inline cgraph_node *first_function (void);
2093
2094 /* Return next function. */
2095 inline cgraph_node *next_function (cgraph_node *node);
2096
2097 /* Return first function with body defined. */
2098 cgraph_node *first_function_with_gimple_body (void);
2099
2100 /* Return next reachable static variable with initializer after NODE. */
2101 inline cgraph_node *next_function_with_gimple_body (cgraph_node *node);
2102
2103 /* Register HOOK to be called with DATA on each removed edge. */
2104 cgraph_edge_hook_list *add_edge_removal_hook (cgraph_edge_hook hook,
2105 void *data);
2106
2107 /* Remove ENTRY from the list of hooks called on removing edges. */
2108 void remove_edge_removal_hook (cgraph_edge_hook_list *entry);
2109
2110 /* Register HOOK to be called with DATA on each removed node. */
2111 cgraph_node_hook_list *add_cgraph_removal_hook (cgraph_node_hook hook,
2112 void *data);
2113
2114 /* Remove ENTRY from the list of hooks called on removing nodes. */
2115 void remove_cgraph_removal_hook (cgraph_node_hook_list *entry);
2116
2117 /* Register HOOK to be called with DATA on each removed node. */
2118 varpool_node_hook_list *add_varpool_removal_hook (varpool_node_hook hook,
2119 void *data);
2120
2121 /* Remove ENTRY from the list of hooks called on removing nodes. */
2122 void remove_varpool_removal_hook (varpool_node_hook_list *entry);
2123
2124 /* Register HOOK to be called with DATA on each inserted node. */
2125 cgraph_node_hook_list *add_cgraph_insertion_hook (cgraph_node_hook hook,
2126 void *data);
2127
2128 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2129 void remove_cgraph_insertion_hook (cgraph_node_hook_list *entry);
2130
2131 /* Register HOOK to be called with DATA on each inserted node. */
2132 varpool_node_hook_list *add_varpool_insertion_hook (varpool_node_hook hook,
2133 void *data);
2134
2135 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2136 void remove_varpool_insertion_hook (varpool_node_hook_list *entry);
2137
2138 /* Register HOOK to be called with DATA on each duplicated edge. */
2139 cgraph_2edge_hook_list *add_edge_duplication_hook (cgraph_2edge_hook hook,
2140 void *data);
2141 /* Remove ENTRY from the list of hooks called on duplicating edges. */
2142 void remove_edge_duplication_hook (cgraph_2edge_hook_list *entry);
2143
2144 /* Register HOOK to be called with DATA on each duplicated node. */
2145 cgraph_2node_hook_list *add_cgraph_duplication_hook (cgraph_2node_hook hook,
2146 void *data);
2147
2148 /* Remove ENTRY from the list of hooks called on duplicating nodes. */
2149 void remove_cgraph_duplication_hook (cgraph_2node_hook_list *entry);
2150
2151 /* Call all edge removal hooks. */
2152 void call_edge_removal_hooks (cgraph_edge *e);
2153
2154 /* Call all node insertion hooks. */
2155 void call_cgraph_insertion_hooks (cgraph_node *node);
2156
2157 /* Call all node removal hooks. */
2158 void call_cgraph_removal_hooks (cgraph_node *node);
2159
2160 /* Call all node duplication hooks. */
2161 void call_cgraph_duplication_hooks (cgraph_node *node, cgraph_node *node2);
2162
2163 /* Call all edge duplication hooks. */
2164 void call_edge_duplication_hooks (cgraph_edge *cs1, cgraph_edge *cs2);
2165
2166 /* Call all node removal hooks. */
2167 void call_varpool_removal_hooks (varpool_node *node);
2168
2169 /* Call all node insertion hooks. */
2170 void call_varpool_insertion_hooks (varpool_node *node);
2171
2172 /* Arrange node to be first in its entry of assembler_name_hash. */
2173 void symtab_prevail_in_asm_name_hash (symtab_node *node);
2174
2175 /* Initalize asm name hash unless. */
2176 void symtab_initialize_asm_name_hash (void);
2177
2178 /* Set the DECL_ASSEMBLER_NAME and update symtab hashtables. */
2179 void change_decl_assembler_name (tree decl, tree name);
e69529cd 2180
71e54687
JH
2181 /* Return true if assembler names NAME1 and NAME2 leads to the same symbol
2182 name. */
2183 static bool assembler_names_equal_p (const char *name1, const char *name2);
2184
3dafb85c
ML
2185 int cgraph_count;
2186 int cgraph_max_uid;
4008290f 2187 int cgraph_max_summary_uid;
3dafb85c
ML
2188
2189 int edges_count;
2190 int edges_max_uid;
2191
2192 symtab_node* GTY(()) nodes;
2193 asm_node* GTY(()) asmnodes;
2194 asm_node* GTY(()) asm_last_node;
2195 cgraph_node* GTY(()) free_nodes;
2196
2197 /* Head of a linked list of unused (freed) call graph edges.
2198 Do not GTY((delete)) this list so UIDs gets reliably recycled. */
2199 cgraph_edge * GTY(()) free_edges;
2200
2201 /* The order index of the next symtab node to be created. This is
2202 used so that we can sort the cgraph nodes in order by when we saw
2203 them, to support -fno-toplevel-reorder. */
2204 int order;
2205
2206 /* Set when whole unit has been analyzed so we can access global info. */
2207 bool global_info_ready;
2208 /* What state callgraph is in right now. */
2209 enum symtab_state state;
2210 /* Set when the cgraph is fully build and the basic flags are computed. */
2211 bool function_flags_ready;
2212
2213 bool cpp_implicit_aliases_done;
2214
2215 /* Hash table used to hold sectoons. */
2a22f99c 2216 hash_table<section_name_hasher> *GTY(()) section_hash;
3dafb85c
ML
2217
2218 /* Hash table used to convert assembler names into nodes. */
2a22f99c 2219 hash_table<asmname_hasher> *assembler_name_hash;
3dafb85c
ML
2220
2221 /* Hash table used to hold init priorities. */
b086d530 2222 hash_map<symtab_node *, symbol_priority_map> *init_priority_hash;
3dafb85c
ML
2223
2224 FILE* GTY ((skip)) dump_file;
2225
f8a1abf8
JH
2226 /* Return symbol used to separate symbol name from suffix. */
2227 static char symbol_suffix_separator ();
2228
0bdad123
ML
2229 FILE* GTY ((skip)) ipa_clones_dump_file;
2230
2231 hash_set <const cgraph_node *> GTY ((skip)) cloned_nodes;
2232
3dafb85c
ML
2233private:
2234 /* Allocate new callgraph node. */
2235 inline cgraph_node * allocate_cgraph_symbol (void);
2236
2237 /* Allocate a cgraph_edge structure and fill it with data according to the
2238 parameters of which only CALLEE can be NULL (when creating an indirect call
2239 edge). */
2240 cgraph_edge *create_edge (cgraph_node *caller, cgraph_node *callee,
538dd0b7 2241 gcall *call_stmt, gcov_type count, int freq,
3dafb85c
ML
2242 bool indir_unknown_callee);
2243
2244 /* Put the edge onto the free list. */
2245 void free_edge (cgraph_edge *e);
2246
2247 /* Insert NODE to assembler name hash. */
2248 void insert_to_assembler_name_hash (symtab_node *node, bool with_clones);
2249
2250 /* Remove NODE from assembler name hash. */
2251 void unlink_from_assembler_name_hash (symtab_node *node, bool with_clones);
2252
2253 /* Hash asmnames ignoring the user specified marks. */
2254 static hashval_t decl_assembler_name_hash (const_tree asmname);
2255
2256 /* Compare ASMNAME with the DECL_ASSEMBLER_NAME of DECL. */
2257 static bool decl_assembler_name_equal (tree decl, const_tree asmname);
2258
2a22f99c 2259 friend struct asmname_hasher;
3dafb85c
ML
2260
2261 /* List of hooks triggered when an edge is removed. */
2262 cgraph_edge_hook_list * GTY((skip)) m_first_edge_removal_hook;
2263 /* List of hooks triggem_red when a cgraph node is removed. */
2264 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_removal_hook;
2265 /* List of hooks triggered when an edge is duplicated. */
2266 cgraph_2edge_hook_list * GTY((skip)) m_first_edge_duplicated_hook;
2267 /* List of hooks triggered when a node is duplicated. */
2268 cgraph_2node_hook_list * GTY((skip)) m_first_cgraph_duplicated_hook;
2269 /* List of hooks triggered when an function is inserted. */
2270 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_insertion_hook;
2271 /* List of hooks triggered when an variable is inserted. */
2272 varpool_node_hook_list * GTY((skip)) m_first_varpool_insertion_hook;
2273 /* List of hooks triggered when a node is removed. */
2274 varpool_node_hook_list * GTY((skip)) m_first_varpool_removal_hook;
2275};
2276
2277extern GTY(()) symbol_table *symtab;
2278
2279extern vec<cgraph_node *> cgraph_new_nodes;
2aae7680 2280
2a22f99c
TS
2281inline hashval_t
2282asmname_hasher::hash (symtab_node *n)
2283{
2284 return symbol_table::decl_assembler_name_hash
2285 (DECL_ASSEMBLER_NAME (n->decl));
2286}
2287
2288inline bool
2289asmname_hasher::equal (symtab_node *n, const_tree t)
2290{
2291 return symbol_table::decl_assembler_name_equal (n->decl, t);
2292}
2293
1c4a429a 2294/* In cgraph.c */
3edf64aa 2295void cgraph_c_finalize (void);
12123452 2296void release_function_body (tree);
3dafb85c 2297cgraph_indirect_call_info *cgraph_allocate_init_indirect_info (void);
d52f5295 2298
355fe088 2299void cgraph_update_edges_for_call_stmt (gimple *, tree, gimple *);
1bb17c21
JH
2300bool cgraph_function_possibly_inlined_p (tree);
2301
61a05df1 2302const char* cgraph_inline_failed_string (cgraph_inline_failed_t);
1cf11770 2303cgraph_inline_failed_type_t cgraph_inline_failed_type (cgraph_inline_failed_t);
6b02a499 2304
355fe088 2305extern bool gimple_check_call_matching_types (gimple *, tree, bool);
9c8305f8
JH
2306
2307/* In cgraphunit.c */
3edf64aa
DM
2308void cgraphunit_c_finalize (void);
2309
3649b9b7
ST
2310/* Initialize datastructures so DECL is a function in lowered gimple form.
2311 IN_SSA is true if the gimple is in SSA. */
10881cff 2312basic_block init_lowered_empty_function (tree, bool, gcov_type);
66a20fc2 2313
6bbf39b7 2314tree thunk_adjust (gimple_stmt_iterator *, tree, bool, HOST_WIDE_INT, tree);
66a20fc2
JH
2315/* In cgraphclones.c */
2316
9816367c 2317tree clone_function_name_1 (const char *, const char *);
66a20fc2 2318tree clone_function_name (tree decl, const char *);
d52f5295 2319
d52f5295 2320void tree_function_versioning (tree, tree, vec<ipa_replace_map *, va_gc> *,
9c8305f8 2321 bool, bitmap, bool, bitmap, basic_block);
9c8305f8 2322
0bdad123
ML
2323void dump_callgraph_transformation (const cgraph_node *original,
2324 const cgraph_node *clone,
2325 const char *suffix);
b0fd4d7e
MJ
2326tree cgraph_build_function_type_skip_args (tree orig_type, bitmap args_to_skip,
2327 bool skip_return);
0bdad123 2328
917948d3 2329/* In cgraphbuild.c */
9187e02d 2330int compute_call_stmt_bb_frequency (tree, basic_block bb);
9c8305f8 2331void record_references_in_initializer (tree, bool);
917948d3 2332
ca31b95f 2333/* In ipa.c */
9c8305f8 2334void cgraph_build_static_cdtor (char which, tree body, int priority);
dea91a66 2335bool ipa_discover_readonly_nonaddressable_vars (void);
ca31b95f 2336
8a4a83ed 2337/* In varpool.c */
6a6dac52 2338tree ctor_for_folding (tree);
68e56cc4 2339
31de7606
JH
2340/* In tree-chkp.c */
2341extern bool chkp_function_instrumented_p (tree fndecl);
2342
27d020cf
JH
2343/* In ipa-inline-analysis.c */
2344void initialize_inline_failed (struct cgraph_edge *);
2345bool speculation_useful_p (struct cgraph_edge *e, bool anticipate_inlining);
2346
d52f5295
ML
2347/* Return true when the symbol is real symbol, i.e. it is not inline clone
2348 or abstract function kept for debug info purposes only. */
2349inline bool
2350symtab_node::real_symbol_p (void)
2351{
2352 cgraph_node *cnode;
2353
00de328a 2354 if (DECL_ABSTRACT_P (decl))
d52f5295 2355 return false;
71e54687
JH
2356 if (transparent_alias && definition)
2357 return false;
d52f5295
ML
2358 if (!is_a <cgraph_node *> (this))
2359 return true;
2360 cnode = dyn_cast <cgraph_node *> (this);
2361 if (cnode->global.inlined_to)
2362 return false;
2363 return true;
2364}
2365
89330618 2366/* Return true if DECL should have entry in symbol table if used.
97b7f138 2367 Those are functions and static & external veriables*/
89330618 2368
0241e486 2369static inline bool
89330618
JH
2370decl_in_symtab_p (const_tree decl)
2371{
2372 return (TREE_CODE (decl) == FUNCTION_DECL
2373 || (TREE_CODE (decl) == VAR_DECL
2374 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl))));
2375}
2376
d52f5295
ML
2377inline bool
2378symtab_node::in_same_comdat_group_p (symtab_node *target)
aede2c10 2379{
d52f5295 2380 symtab_node *source = this;
aede2c10 2381
d52f5295
ML
2382 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2383 {
2384 if (cn->global.inlined_to)
2385 source = cn->global.inlined_to;
2386 }
2387 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2388 {
2389 if (cn->global.inlined_to)
2390 target = cn->global.inlined_to;
2391 }
2392
2393 return source->get_comdat_group () == target->get_comdat_group ();
1f00098b
JH
2394}
2395
d52f5295
ML
2396/* Return node that alias is aliasing. */
2397
2398inline symtab_node *
2399symtab_node::get_alias_target (void)
1f00098b 2400{
3dafb85c 2401 ipa_ref *ref = NULL;
d52f5295 2402 iterate_reference (0, ref);
d5e254e1
IE
2403 if (ref->use == IPA_REF_CHKP)
2404 iterate_reference (1, ref);
d52f5295
ML
2405 gcc_checking_assert (ref->use == IPA_REF_ALIAS);
2406 return ref->referred;
1f00098b
JH
2407}
2408
d52f5295 2409/* Return next reachable static symbol with initializer after the node. */
31de7606 2410
d52f5295
ML
2411inline symtab_node *
2412symtab_node::next_defined_symbol (void)
1ab24192 2413{
d52f5295
ML
2414 symtab_node *node1 = next;
2415
2416 for (; node1; node1 = node1->next)
2417 if (node1->definition)
2418 return node1;
2419
2420 return NULL;
1ab24192
JH
2421}
2422
31de7606
JH
2423/* Iterates I-th reference in the list, REF is also set. */
2424
2425inline ipa_ref *
2426symtab_node::iterate_reference (unsigned i, ipa_ref *&ref)
2427{
2428 vec_safe_iterate (ref_list.references, i, &ref);
2429
2430 return ref;
2431}
2432
2433/* Iterates I-th referring item in the list, REF is also set. */
2434
2435inline ipa_ref *
2436symtab_node::iterate_referring (unsigned i, ipa_ref *&ref)
2437{
2438 ref_list.referring.iterate (i, &ref);
2439
2440 return ref;
2441}
2442
2443/* Iterates I-th referring alias item in the list, REF is also set. */
2444
2445inline ipa_ref *
2446symtab_node::iterate_direct_aliases (unsigned i, ipa_ref *&ref)
2447{
2448 ref_list.referring.iterate (i, &ref);
2449
2450 if (ref && ref->use != IPA_REF_ALIAS)
2451 return NULL;
2452
2453 return ref;
2454}
2455
2456/* Return true if list contains an alias. */
2457
2458inline bool
2459symtab_node::has_aliases_p (void)
2460{
2461 ipa_ref *ref = NULL;
31de7606 2462
190bbd0b 2463 return (iterate_direct_aliases (0, ref) != NULL);
31de7606
JH
2464}
2465
2466/* Return true when RESOLUTION indicate that linker will use
2467 the symbol from non-LTO object files. */
2468
2469inline bool
2470resolution_used_from_other_file_p (enum ld_plugin_symbol_resolution resolution)
2471{
2472 return (resolution == LDPR_PREVAILING_DEF
2473 || resolution == LDPR_PREEMPTED_REG
2474 || resolution == LDPR_RESOLVED_EXEC
2475 || resolution == LDPR_RESOLVED_DYN);
2476}
2477
2478/* Return true when symtab_node is known to be used from other (non-LTO)
2479 object file. Known only when doing LTO via linker plugin. */
2480
2481inline bool
2482symtab_node::used_from_object_file_p (void)
2483{
2484 if (!TREE_PUBLIC (decl) || DECL_EXTERNAL (decl))
2485 return false;
2486 if (resolution_used_from_other_file_p (resolution))
2487 return true;
2488 return false;
2489}
2490
1ab24192 2491/* Return varpool node for given symbol and check it is a function. */
3dafb85c 2492
9041d2e6
ML
2493inline varpool_node *
2494varpool_node::get (const_tree decl)
1ab24192
JH
2495{
2496 gcc_checking_assert (TREE_CODE (decl) == VAR_DECL);
d52f5295 2497 return dyn_cast<varpool_node *> (symtab_node::get (decl));
1ab24192
JH
2498}
2499
3dafb85c
ML
2500/* Register a symbol NODE. */
2501
2502inline void
2503symbol_table::register_symbol (symtab_node *node)
2504{
2505 node->next = nodes;
2506 node->previous = NULL;
2507
2508 if (nodes)
2509 nodes->previous = node;
2510 nodes = node;
2511
2512 node->order = order++;
2513}
2514
2515/* Register a top-level asm statement ASM_STR. */
2516
2517asm_node *
2518symbol_table::finalize_toplevel_asm (tree asm_str)
2519{
2520 asm_node *node;
2521
2522 node = ggc_cleared_alloc<asm_node> ();
2523 node->asm_str = asm_str;
2524 node->order = order++;
2525 node->next = NULL;
2526
2527 if (asmnodes == NULL)
2528 asmnodes = node;
2529 else
2530 asm_last_node->next = node;
2531
2532 asm_last_node = node;
2533 return node;
2534}
2535
2536/* Unregister a symbol NODE. */
2537inline void
2538symbol_table::unregister (symtab_node *node)
2539{
2540 if (node->previous)
2541 node->previous->next = node->next;
2542 else
2543 nodes = node->next;
2544
2545 if (node->next)
2546 node->next->previous = node->previous;
2547
2548 node->next = NULL;
2549 node->previous = NULL;
2550}
2551
3dafb85c
ML
2552/* Release a callgraph NODE with UID and put in to the list of free nodes. */
2553
2554inline void
2555symbol_table::release_symbol (cgraph_node *node, int uid)
2556{
2557 cgraph_count--;
2558
2559 /* Clear out the node to NULL all pointers and add the node to the free
2560 list. */
2561 memset (node, 0, sizeof (*node));
2562 node->type = SYMTAB_FUNCTION;
2563 node->uid = uid;
2564 SET_NEXT_FREE_NODE (node, free_nodes);
2565 free_nodes = node;
2566}
2567
2568/* Allocate new callgraph node. */
2569
2570inline cgraph_node *
2571symbol_table::allocate_cgraph_symbol (void)
2572{
2573 cgraph_node *node;
2574
2575 if (free_nodes)
2576 {
2577 node = free_nodes;
2578 free_nodes = NEXT_FREE_NODE (node);
2579 }
2580 else
2581 {
2582 node = ggc_cleared_alloc<cgraph_node> ();
2583 node->uid = cgraph_max_uid++;
2584 }
2585
4008290f 2586 node->summary_uid = cgraph_max_summary_uid++;
3dafb85c
ML
2587 return node;
2588}
2589
2590
2591/* Return first static symbol with definition. */
2592inline symtab_node *
2593symbol_table::first_symbol (void)
2594{
2595 return nodes;
2596}
2597
1ab24192
JH
2598/* Walk all symbols. */
2599#define FOR_EACH_SYMBOL(node) \
3dafb85c 2600 for ((node) = symtab->first_symbol (); (node); (node) = (node)->next)
1f00098b 2601
d6d229c6 2602/* Return first static symbol with definition. */
3dafb85c
ML
2603inline symtab_node *
2604symbol_table::first_defined_symbol (void)
d6d229c6
JH
2605{
2606 symtab_node *node;
2607
3dafb85c 2608 for (node = nodes; node; node = node->next)
d6d229c6
JH
2609 if (node->definition)
2610 return node;
2611
2612 return NULL;
2613}
2614
d6d229c6
JH
2615/* Walk all symbols with definitions in current unit. */
2616#define FOR_EACH_DEFINED_SYMBOL(node) \
3dafb85c 2617 for ((node) = symtab->first_defined_symbol (); (node); \
d52f5295 2618 (node) = node->next_defined_symbol ())
66058468
JH
2619
2620/* Return first variable. */
3dafb85c
ML
2621inline varpool_node *
2622symbol_table::first_variable (void)
66058468 2623{
5e20cdc9 2624 symtab_node *node;
3dafb85c 2625 for (node = nodes; node; node = node->next)
7de90a6c 2626 if (varpool_node *vnode = dyn_cast <varpool_node *> (node))
5d59b5e1 2627 return vnode;
66058468
JH
2628 return NULL;
2629}
2630
2631/* Return next variable after NODE. */
3dafb85c
ML
2632inline varpool_node *
2633symbol_table::next_variable (varpool_node *node)
66058468 2634{
5e20cdc9 2635 symtab_node *node1 = node->next;
67348ccc 2636 for (; node1; node1 = node1->next)
7de90a6c 2637 if (varpool_node *vnode1 = dyn_cast <varpool_node *> (node1))
5d59b5e1 2638 return vnode1;
66058468
JH
2639 return NULL;
2640}
2641/* Walk all variables. */
2642#define FOR_EACH_VARIABLE(node) \
3dafb85c 2643 for ((node) = symtab->first_variable (); \
66058468 2644 (node); \
3dafb85c 2645 (node) = symtab->next_variable ((node)))
66058468 2646
d6d229c6 2647/* Return first static variable with initializer. */
3dafb85c
ML
2648inline varpool_node *
2649symbol_table::first_static_initializer (void)
68e56cc4 2650{
5e20cdc9 2651 symtab_node *node;
3dafb85c 2652 for (node = nodes; node; node = node->next)
68e56cc4 2653 {
7de90a6c 2654 varpool_node *vnode = dyn_cast <varpool_node *> (node);
67348ccc 2655 if (vnode && DECL_INITIAL (node->decl))
5d59b5e1 2656 return vnode;
68e56cc4
JH
2657 }
2658 return NULL;
2659}
2660
d6d229c6 2661/* Return next static variable with initializer after NODE. */
3dafb85c
ML
2662inline varpool_node *
2663symbol_table::next_static_initializer (varpool_node *node)
68e56cc4 2664{
5e20cdc9 2665 symtab_node *node1 = node->next;
67348ccc 2666 for (; node1; node1 = node1->next)
68e56cc4 2667 {
7de90a6c 2668 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
67348ccc 2669 if (vnode1 && DECL_INITIAL (node1->decl))
5d59b5e1 2670 return vnode1;
68e56cc4
JH
2671 }
2672 return NULL;
2673}
2674
2675/* Walk all static variables with initializer set. */
2676#define FOR_EACH_STATIC_INITIALIZER(node) \
3dafb85c
ML
2677 for ((node) = symtab->first_static_initializer (); (node); \
2678 (node) = symtab->next_static_initializer (node))
2aae7680 2679
d6d229c6 2680/* Return first static variable with definition. */
3dafb85c
ML
2681inline varpool_node *
2682symbol_table::first_defined_variable (void)
2aae7680 2683{
5e20cdc9 2684 symtab_node *node;
3dafb85c 2685 for (node = nodes; node; node = node->next)
2aae7680 2686 {
7de90a6c 2687 varpool_node *vnode = dyn_cast <varpool_node *> (node);
67348ccc 2688 if (vnode && vnode->definition)
5d59b5e1 2689 return vnode;
2aae7680
JH
2690 }
2691 return NULL;
2692}
2693
d6d229c6 2694/* Return next static variable with definition after NODE. */
3dafb85c
ML
2695inline varpool_node *
2696symbol_table::next_defined_variable (varpool_node *node)
2aae7680 2697{
5e20cdc9 2698 symtab_node *node1 = node->next;
67348ccc 2699 for (; node1; node1 = node1->next)
2aae7680 2700 {
7de90a6c 2701 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
67348ccc 2702 if (vnode1 && vnode1->definition)
5d59b5e1 2703 return vnode1;
2aae7680
JH
2704 }
2705 return NULL;
2706}
65c70e6b
JH
2707/* Walk all variables with definitions in current unit. */
2708#define FOR_EACH_DEFINED_VARIABLE(node) \
3dafb85c
ML
2709 for ((node) = symtab->first_defined_variable (); (node); \
2710 (node) = symtab->next_defined_variable (node))
68e56cc4 2711
c47d0034 2712/* Return first function with body defined. */
3dafb85c
ML
2713inline cgraph_node *
2714symbol_table::first_defined_function (void)
c47d0034 2715{
5e20cdc9 2716 symtab_node *node;
3dafb85c 2717 for (node = nodes; node; node = node->next)
c47d0034 2718 {
7de90a6c 2719 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
67348ccc 2720 if (cn && cn->definition)
5d59b5e1 2721 return cn;
c47d0034
JH
2722 }
2723 return NULL;
2724}
2725
45896127 2726/* Return next function with body defined after NODE. */
3dafb85c
ML
2727inline cgraph_node *
2728symbol_table::next_defined_function (cgraph_node *node)
c47d0034 2729{
5e20cdc9 2730 symtab_node *node1 = node->next;
67348ccc 2731 for (; node1; node1 = node1->next)
c47d0034 2732 {
7de90a6c 2733 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
67348ccc 2734 if (cn1 && cn1->definition)
5d59b5e1 2735 return cn1;
c47d0034
JH
2736 }
2737 return NULL;
2738}
2739
2740/* Walk all functions with body defined. */
2741#define FOR_EACH_DEFINED_FUNCTION(node) \
3dafb85c
ML
2742 for ((node) = symtab->first_defined_function (); (node); \
2743 (node) = symtab->next_defined_function ((node)))
2aae7680
JH
2744
2745/* Return first function. */
3dafb85c
ML
2746inline cgraph_node *
2747symbol_table::first_function (void)
2aae7680 2748{
5e20cdc9 2749 symtab_node *node;
3dafb85c 2750 for (node = nodes; node; node = node->next)
7de90a6c 2751 if (cgraph_node *cn = dyn_cast <cgraph_node *> (node))
5d59b5e1 2752 return cn;
2aae7680
JH
2753 return NULL;
2754}
2755
2756/* Return next function. */
3dafb85c
ML
2757inline cgraph_node *
2758symbol_table::next_function (cgraph_node *node)
2aae7680 2759{
5e20cdc9 2760 symtab_node *node1 = node->next;
67348ccc 2761 for (; node1; node1 = node1->next)
7de90a6c 2762 if (cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1))
5d59b5e1 2763 return cn1;
2aae7680
JH
2764 return NULL;
2765}
c47d0034
JH
2766
2767/* Return first function with body defined. */
3dafb85c
ML
2768inline cgraph_node *
2769symbol_table::first_function_with_gimple_body (void)
c47d0034 2770{
5e20cdc9 2771 symtab_node *node;
3dafb85c 2772 for (node = nodes; node; node = node->next)
c47d0034 2773 {
7de90a6c 2774 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
d52f5295 2775 if (cn && cn->has_gimple_body_p ())
5d59b5e1 2776 return cn;
c47d0034
JH
2777 }
2778 return NULL;
2779}
2780
2781/* Return next reachable static variable with initializer after NODE. */
3dafb85c
ML
2782inline cgraph_node *
2783symbol_table::next_function_with_gimple_body (cgraph_node *node)
c47d0034 2784{
5e20cdc9 2785 symtab_node *node1 = node->next;
67348ccc 2786 for (; node1; node1 = node1->next)
c47d0034 2787 {
7de90a6c 2788 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
d52f5295 2789 if (cn1 && cn1->has_gimple_body_p ())
5d59b5e1 2790 return cn1;
c47d0034
JH
2791 }
2792 return NULL;
2793}
2794
3dafb85c
ML
2795/* Walk all functions. */
2796#define FOR_EACH_FUNCTION(node) \
2797 for ((node) = symtab->first_function (); (node); \
2798 (node) = symtab->next_function ((node)))
2799
2800/* Return true when callgraph node is a function with Gimple body defined
2801 in current unit. Functions can also be define externally or they
2802 can be thunks with no Gimple representation.
2803
2804 Note that at WPA stage, the function body may not be present in memory. */
2805
2806inline bool
2807cgraph_node::has_gimple_body_p (void)
2808{
2809 return definition && !thunk.thunk_p && !alias;
2810}
2811
c47d0034
JH
2812/* Walk all functions with body defined. */
2813#define FOR_EACH_FUNCTION_WITH_GIMPLE_BODY(node) \
3dafb85c
ML
2814 for ((node) = symtab->first_function_with_gimple_body (); (node); \
2815 (node) = symtab->next_function_with_gimple_body (node))
c47d0034 2816
d48e9cea
OR
2817/* Uniquize all constants that appear in memory.
2818 Each constant in memory thus far output is recorded
2819 in `const_desc_table'. */
2820
2a22f99c 2821struct GTY((for_user)) constant_descriptor_tree {
d48e9cea
OR
2822 /* A MEM for the constant. */
2823 rtx rtl;
b8698a0f 2824
d48e9cea
OR
2825 /* The value of the constant. */
2826 tree value;
2827
2828 /* Hash of value. Computing the hash from value each time
2829 hashfn is called can't work properly, as that means recursive
2830 use of the hash table during hash table expansion. */
2831 hashval_t hash;
2832};
2833
d52f5295 2834/* Return true when function is only called directly or it has alias.
b20996ff
JH
2835 i.e. it is not externally visible, address was not taken and
2836 it is not used in any other non-standard way. */
2837
d52f5295
ML
2838inline bool
2839cgraph_node::only_called_directly_or_aliased_p (void)
2840{
2841 gcc_assert (!global.inlined_to);
2842 return (!force_output && !address_taken
2843 && !used_from_other_partition
2844 && !DECL_VIRTUAL_P (decl)
2845 && !DECL_STATIC_CONSTRUCTOR (decl)
2846 && !DECL_STATIC_DESTRUCTOR (decl)
a6a543bf 2847 && !used_from_object_file_p ()
d52f5295 2848 && !externally_visible);
b20996ff
JH
2849}
2850
31de7606
JH
2851/* Return true when function can be removed from callgraph
2852 if all direct calls are eliminated. */
2853
2854inline bool
2855cgraph_node::can_remove_if_no_direct_calls_and_refs_p (void)
2856{
2857 gcc_checking_assert (!global.inlined_to);
2858 /* Instrumentation clones should not be removed before
2859 instrumentation happens. New callers may appear after
2860 instrumentation. */
2861 if (instrumentation_clone
2862 && !chkp_function_instrumented_p (decl))
2863 return false;
2864 /* Extern inlines can always go, we will use the external definition. */
2865 if (DECL_EXTERNAL (decl))
2866 return true;
2867 /* When function is needed, we can not remove it. */
2868 if (force_output || used_from_other_partition)
2869 return false;
2870 if (DECL_STATIC_CONSTRUCTOR (decl)
2871 || DECL_STATIC_DESTRUCTOR (decl))
2872 return false;
2873 /* Only COMDAT functions can be removed if externally visible. */
2874 if (externally_visible
2875 && (!DECL_COMDAT (decl)
2876 || forced_by_abi
2877 || used_from_object_file_p ()))
2878 return false;
2879 return true;
2880}
2881
b2b29377
MM
2882/* Verify cgraph, if consistency checking is enabled. */
2883
2884inline void
2885cgraph_node::checking_verify_cgraph_nodes (void)
2886{
2887 if (flag_checking)
2888 cgraph_node::verify_cgraph_nodes ();
2889}
2890
9041d2e6 2891/* Return true when variable can be removed from variable pool
df7705b1
JH
2892 if all direct calls are eliminated. */
2893
9041d2e6
ML
2894inline bool
2895varpool_node::can_remove_if_no_refs_p (void)
df7705b1 2896{
9041d2e6 2897 if (DECL_EXTERNAL (decl))
6649df51 2898 return true;
9041d2e6
ML
2899 return (!force_output && !used_from_other_partition
2900 && ((DECL_COMDAT (decl)
2901 && !forced_by_abi
2902 && !used_from_object_file_p ())
2903 || !externally_visible
2904 || DECL_HAS_VALUE_EXPR_P (decl)));
df7705b1
JH
2905}
2906
9041d2e6 2907/* Return true when all references to variable must be visible in ipa_ref_list.
4a444e58
JH
2908 i.e. if the variable is not externally visible or not used in some magic
2909 way (asm statement or such).
61502ca8 2910 The magic uses are all summarized in force_output flag. */
4a444e58 2911
9041d2e6
ML
2912inline bool
2913varpool_node::all_refs_explicit_p ()
4a444e58 2914{
9041d2e6
ML
2915 return (definition
2916 && !externally_visible
2917 && !used_from_other_partition
2918 && !force_output);
4a444e58
JH
2919}
2920
ca752f39 2921struct tree_descriptor_hasher : ggc_ptr_hash<constant_descriptor_tree>
2a22f99c
TS
2922{
2923 static hashval_t hash (constant_descriptor_tree *);
2924 static bool equal (constant_descriptor_tree *, constant_descriptor_tree *);
2925};
2926
d48e9cea 2927/* Constant pool accessor function. */
2a22f99c 2928hash_table<tree_descriptor_hasher> *constant_pool_htab (void);
fed5ae11 2929
d52f5295 2930/* Return node that alias is aliasing. */
39e2db00 2931
d52f5295
ML
2932inline cgraph_node *
2933cgraph_node::get_alias_target (void)
cd35bcf7 2934{
d52f5295 2935 return dyn_cast <cgraph_node *> (symtab_node::get_alias_target ());
cd35bcf7
JH
2936}
2937
9041d2e6
ML
2938/* Return node that alias is aliasing. */
2939
2940inline varpool_node *
2941varpool_node::get_alias_target (void)
be330ed4 2942{
9041d2e6 2943 return dyn_cast <varpool_node *> (symtab_node::get_alias_target ());
be330ed4
JH
2944}
2945
31de7606
JH
2946/* Walk the alias chain to return the symbol NODE is alias of.
2947 If NODE is not an alias, return NODE.
f13fe18b
JH
2948 When AVAILABILITY is non-NULL, get minimal availability in the chain.
2949 When REF is non-NULL, assume that reference happens in symbol REF
2950 when determining the availability. */
31de7606
JH
2951
2952inline symtab_node *
f13fe18b
JH
2953symtab_node::ultimate_alias_target (enum availability *availability,
2954 symtab_node *ref)
31de7606
JH
2955{
2956 if (!alias)
2957 {
2958 if (availability)
f13fe18b 2959 *availability = get_availability (ref);
31de7606
JH
2960 return this;
2961 }
2962
f13fe18b 2963 return ultimate_alias_target_1 (availability, ref);
31de7606
JH
2964}
2965
d52f5295
ML
2966/* Given function symbol, walk the alias chain to return the function node
2967 is alias of. Do not walk through thunks.
f13fe18b
JH
2968 When AVAILABILITY is non-NULL, get minimal availability in the chain.
2969 When REF is non-NULL, assume that reference happens in symbol REF
2970 when determining the availability. */
be330ed4 2971
d52f5295 2972inline cgraph_node *
f13fe18b
JH
2973cgraph_node::ultimate_alias_target (enum availability *availability,
2974 symtab_node *ref)
be330ed4 2975{
31de7606 2976 cgraph_node *n = dyn_cast <cgraph_node *>
f13fe18b 2977 (symtab_node::ultimate_alias_target (availability, ref));
40a7fe1e 2978 if (!n && availability)
39e2db00 2979 *availability = AVAIL_NOT_AVAILABLE;
e70670cf 2980 return n;
be330ed4 2981}
9041d2e6
ML
2982
2983/* For given variable pool node, walk the alias chain to return the function
2984 the variable is alias of. Do not walk through thunks.
f13fe18b
JH
2985 When AVAILABILITY is non-NULL, get minimal availability in the chain.
2986 When REF is non-NULL, assume that reference happens in symbol REF
2987 when determining the availability. */
cd35bcf7 2988
9041d2e6 2989inline varpool_node *
f13fe18b
JH
2990varpool_node::ultimate_alias_target (availability *availability,
2991 symtab_node *ref)
cd35bcf7 2992{
9041d2e6 2993 varpool_node *n = dyn_cast <varpool_node *>
f13fe18b 2994 (symtab_node::ultimate_alias_target (availability, ref));
ff36fcbe 2995
40a7fe1e 2996 if (!n && availability)
cd35bcf7 2997 *availability = AVAIL_NOT_AVAILABLE;
e70670cf 2998 return n;
cd35bcf7
JH
2999}
3000
90988f77
ML
3001/* Set callee N of call graph edge and add it to the corresponding set of
3002 callers. */
3003
3004inline void
3005cgraph_edge::set_callee (cgraph_node *n)
3006{
3007 prev_caller = NULL;
3008 if (n->callers)
3009 n->callers->prev_caller = this;
3010 next_caller = n->callers;
3011 n->callers = this;
3012 callee = n;
3013}
3014
3015/* Redirect callee of the edge to N. The function does not update underlying
3016 call expression. */
3017
3018inline void
3019cgraph_edge::redirect_callee (cgraph_node *n)
3020{
3021 /* Remove from callers list of the current callee. */
3022 remove_callee ();
3023
3024 /* Insert to callers list of the new callee. */
3025 set_callee (n);
3026}
3027
3dafb85c 3028/* Return true when the edge represents a direct recursion. */
31de7606 3029
3dafb85c
ML
3030inline bool
3031cgraph_edge::recursive_p (void)
d7d1d041 3032{
3dafb85c
ML
3033 cgraph_node *c = callee->ultimate_alias_target ();
3034 if (caller->global.inlined_to)
3035 return caller->global.inlined_to->decl == c->decl;
d7d1d041 3036 else
3dafb85c 3037 return caller->decl == c->decl;
d7d1d041 3038}
0a35513e 3039
90988f77
ML
3040/* Remove the edge from the list of the callers of the callee. */
3041
3042inline void
3043cgraph_edge::remove_callee (void)
3044{
3045 gcc_assert (!indirect_unknown_callee);
3046 if (prev_caller)
3047 prev_caller->next_caller = next_caller;
3048 if (next_caller)
3049 next_caller->prev_caller = prev_caller;
3050 if (!prev_caller)
3051 callee->callers = next_caller;
3052}
3053
f13fe18b
JH
3054/* Return true if call must bind to current definition. */
3055
3056inline bool
3057cgraph_edge::binds_to_current_def_p ()
3058{
3059 if (callee)
3060 return callee->binds_to_current_def_p (caller);
3061 else
aff98801 3062 return false;
f13fe18b
JH
3063}
3064
0a35513e
AH
3065/* Return true if the TM_CLONE bit is set for a given FNDECL. */
3066static inline bool
3067decl_is_tm_clone (const_tree fndecl)
3068{
d52f5295 3069 cgraph_node *n = cgraph_node::get (fndecl);
0a35513e
AH
3070 if (n)
3071 return n->tm_clone;
3072 return false;
3073}
9c8305f8
JH
3074
3075/* Likewise indicate that a node is needed, i.e. reachable via some
3076 external means. */
3077
d52f5295
ML
3078inline void
3079cgraph_node::mark_force_output (void)
1f26ac87 3080{
d52f5295
ML
3081 force_output = 1;
3082 gcc_checking_assert (!global.inlined_to);
1f26ac87
JM
3083}
3084
893479de
AM
3085/* Return true if function should be optimized for size. */
3086
3087inline bool
3088cgraph_node::optimize_for_size_p (void)
3089{
b065b669 3090 if (opt_for_fn (decl, optimize_size))
893479de
AM
3091 return true;
3092 if (frequency == NODE_FREQUENCY_UNLIKELY_EXECUTED)
3093 return true;
3094 else
3095 return false;
3096}
3097
31de7606
JH
3098/* Return symtab_node for NODE or create one if it is not present
3099 in symtab. */
3100
3101inline symtab_node *
3102symtab_node::get_create (tree node)
f7217cde
JH
3103{
3104 if (TREE_CODE (node) == VAR_DECL)
3105 return varpool_node::get_create (node);
3106 else
3107 return cgraph_node::get_create (node);
3108}
3109
f13fe18b 3110/* Return availability of NODE when referenced from REF. */
31de7606
JH
3111
3112inline enum availability
f13fe18b 3113symtab_node::get_availability (symtab_node *ref)
31de7606
JH
3114{
3115 if (is_a <cgraph_node *> (this))
f13fe18b 3116 return dyn_cast <cgraph_node *> (this)->get_availability (ref);
31de7606 3117 else
f13fe18b 3118 return dyn_cast <varpool_node *> (this)->get_availability (ref);
31de7606
JH
3119}
3120
3121/* Call calback on symtab node and aliases associated to this node.
6b715bf6 3122 When INCLUDE_OVERWRITABLE is false, overwritable symbols are skipped. */
31de7606
JH
3123
3124inline bool
3125symtab_node::call_for_symbol_and_aliases (bool (*callback) (symtab_node *,
3126 void *),
3127 void *data,
3128 bool include_overwritable)
3129{
6b715bf6
JH
3130 if (include_overwritable
3131 || get_availability () > AVAIL_INTERPOSABLE)
3132 {
3133 if (callback (this, data))
3134 return true;
3135 }
190bbd0b 3136 if (has_aliases_p ())
31de7606
JH
3137 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3138 return false;
3139}
3140
3141/* Call callback on function and aliases associated to the function.
6b715bf6 3142 When INCLUDE_OVERWRITABLE is false, overwritable symbols are
31de7606
JH
3143 skipped. */
3144
3145inline bool
3146cgraph_node::call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
3147 void *),
3148 void *data,
3149 bool include_overwritable)
3150{
6b715bf6
JH
3151 if (include_overwritable
3152 || get_availability () > AVAIL_INTERPOSABLE)
3153 {
3154 if (callback (this, data))
3155 return true;
3156 }
190bbd0b 3157 if (has_aliases_p ())
31de7606 3158 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
31de7606
JH
3159 return false;
3160}
3161
3162/* Call calback on varpool symbol and aliases associated to varpool symbol.
6b715bf6 3163 When INCLUDE_OVERWRITABLE is false, overwritable symbols are
31de7606
JH
3164 skipped. */
3165
3166inline bool
3167varpool_node::call_for_symbol_and_aliases (bool (*callback) (varpool_node *,
3168 void *),
3169 void *data,
3170 bool include_overwritable)
3171{
6b715bf6
JH
3172 if (include_overwritable
3173 || get_availability () > AVAIL_INTERPOSABLE)
3174 {
3175 if (callback (this, data))
3176 return true;
3177 }
190bbd0b 3178 if (has_aliases_p ())
31de7606 3179 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
31de7606
JH
3180 return false;
3181}
3182
0a7246ee
JH
3183/* Return true if refernece may be used in address compare. */
3184
3185inline bool
3186ipa_ref::address_matters_p ()
3187{
3188 if (use != IPA_REF_ADDR)
3189 return false;
3190 /* Addresses taken from virtual tables are never compared. */
3191 if (is_a <varpool_node *> (referring)
3192 && DECL_VIRTUAL_P (referring->decl))
3193 return false;
3194 return referred->address_can_be_compared_p ();
3195}
3196
ba392339
JH
3197/* Build polymorphic call context for indirect call E. */
3198
3199inline
3200ipa_polymorphic_call_context::ipa_polymorphic_call_context (cgraph_edge *e)
3201{
3202 gcc_checking_assert (e->indirect_info->polymorphic);
3203 *this = e->indirect_info->context;
3204}
3205
3206/* Build empty "I know nothing" context. */
3207
3208inline
3209ipa_polymorphic_call_context::ipa_polymorphic_call_context ()
3210{
3211 clear_speculation ();
3212 clear_outer_type ();
3213 invalid = false;
3214}
3215
3216/* Make context non-speculative. */
3217
3218inline void
3219ipa_polymorphic_call_context::clear_speculation ()
3220{
3221 speculative_outer_type = NULL;
3222 speculative_offset = 0;
3223 speculative_maybe_derived_type = false;
3224}
3225
6ff65dd7
MJ
3226/* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
3227 NULL, the context is set to dummy "I know nothing" setting. */
ba392339
JH
3228
3229inline void
3230ipa_polymorphic_call_context::clear_outer_type (tree otr_type)
3231{
3232 outer_type = otr_type ? TYPE_MAIN_VARIANT (otr_type) : NULL;
3233 offset = 0;
3234 maybe_derived_type = true;
3235 maybe_in_construction = true;
4081ada2 3236 dynamic = true;
ba392339 3237}
67a1b94c
JH
3238
3239/* Adjust all offsets in contexts by OFF bits. */
3240
3241inline void
3242ipa_polymorphic_call_context::offset_by (HOST_WIDE_INT off)
3243{
3244 if (outer_type)
3245 offset += off;
3246 if (speculative_outer_type)
3247 speculative_offset += off;
3248}
3249
3250/* Return TRUE if context is fully useless. */
3251
3252inline bool
3253ipa_polymorphic_call_context::useless_p () const
3254{
3255 return (!outer_type && !speculative_outer_type);
3256}
d5e254e1
IE
3257
3258/* Return true if NODE is local. Instrumentation clones are counted as local
3259 only when original function is local. */
3260
3261static inline bool
3262cgraph_local_p (cgraph_node *node)
3263{
3264 if (!node->instrumentation_clone || !node->instrumented_version)
3265 return node->local.local;
3266
3267 return node->local.local && node->instrumented_version->local.local;
3268}
3269
2a72a953
DM
3270/* When using fprintf (or similar), problems can arise with
3271 transient generated strings. Many string-generation APIs
3272 only support one result being alive at once (e.g. by
3273 returning a pointer to a statically-allocated buffer).
3274
3275 If there is more than one generated string within one
3276 fprintf call: the first string gets evicted or overwritten
3277 by the second, before fprintf is fully evaluated.
3278 See e.g. PR/53136.
3279
3280 This function provides a workaround for this, by providing
3281 a simple way to create copies of these transient strings,
3282 without the need to have explicit cleanup:
3283
3284 fprintf (dumpfile, "string 1: %s string 2:%s\n",
3285 xstrdup_for_dump (EXPR_1),
3286 xstrdup_for_dump (EXPR_2));
3287
3288 This is actually a simple wrapper around ggc_strdup, but
3289 the name documents the intent. We require that no GC can occur
3290 within the fprintf call. */
3291
3292static inline const char *
3293xstrdup_for_dump (const char *transient_str)
3294{
3295 return ggc_strdup (transient_str);
3296}
3297
1c4a429a 3298#endif /* GCC_CGRAPH_H */