1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
|
/* Analysis used by inlining decision heuristics.
Copyright (C) 2003-2019 Free Software Foundation, Inc.
Contributed by Jan Hubicka
This file is part of GCC.
GCC is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 3, or (at your option) any later
version.
GCC is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING3. If not see
<http://www.gnu.org/licenses/>. */
#include "config.h"
#include "system.h"
#include "coretypes.h"
#include "backend.h"
#include "tree.h"
#include "gimple.h"
#include "alloc-pool.h"
#include "tree-pass.h"
#include "ssa.h"
#include "tree-streamer.h"
#include "cgraph.h"
#include "diagnostic.h"
#include "fold-const.h"
#include "print-tree.h"
#include "tree-inline.h"
#include "gimple-pretty-print.h"
#include "params.h"
#include "cfganal.h"
#include "gimple-iterator.h"
#include "tree-cfg.h"
#include "tree-ssa-loop-niter.h"
#include "tree-ssa-loop.h"
#include "symbol-summary.h"
#include "ipa-prop.h"
#include "ipa-fnsummary.h"
#include "ipa-inline.h"
#include "cfgloop.h"
#include "tree-scalar-evolution.h"
#include "ipa-utils.h"
#include "cfgexpand.h"
#include "gimplify.h"
/* Cached node/edge growths. */
fast_call_summary<edge_growth_cache_entry *, va_heap> *edge_growth_cache = NULL;
/* The context cache remembers estimated time/size and hints for given
ipa_call_context of a call. */
class node_context_cache_entry
{
public:
ipa_call_context ctx;
sreal time, nonspec_time;
int size;
ipa_hints hints;
node_context_cache_entry ()
: ctx ()
{
}
~node_context_cache_entry ()
{
ctx.release ();
}
};
/* At the moment we implement primitive single entry LRU cache. */
class node_context_summary
{
public:
node_context_cache_entry entry;
node_context_summary ()
: entry ()
{
}
~node_context_summary ()
{
}
};
/* Summary holding the context cache. */
static fast_function_summary <node_context_summary *, va_heap>
*node_context_cache = NULL;
/* Statistics about the context cache effectivity. */
static long node_context_cache_hit, node_context_cache_miss,
node_context_cache_clear;
/* Give initial reasons why inlining would fail on EDGE. This gets either
nullified or usually overwritten by more precise reasons later. */
void
initialize_inline_failed (struct cgraph_edge *e)
{
struct cgraph_node *callee = e->callee;
if (e->inline_failed && e->inline_failed != CIF_BODY_NOT_AVAILABLE
&& cgraph_inline_failed_type (e->inline_failed) == CIF_FINAL_ERROR)
;
else if (e->indirect_unknown_callee)
e->inline_failed = CIF_INDIRECT_UNKNOWN_CALL;
else if (!callee->definition)
e->inline_failed = CIF_BODY_NOT_AVAILABLE;
else if (callee->redefined_extern_inline)
e->inline_failed = CIF_REDEFINED_EXTERN_INLINE;
else
e->inline_failed = CIF_FUNCTION_NOT_CONSIDERED;
gcc_checking_assert (!e->call_stmt_cannot_inline_p
|| cgraph_inline_failed_type (e->inline_failed)
== CIF_FINAL_ERROR);
}
/* Allocate edge growth caches. */
void
initialize_growth_caches ()
{
edge_growth_cache
= new fast_call_summary<edge_growth_cache_entry *, va_heap> (symtab);
node_context_cache
= new fast_function_summary<node_context_summary *, va_heap> (symtab);
}
/* Free growth caches. */
void
free_growth_caches (void)
{
delete edge_growth_cache;
delete node_context_cache;
edge_growth_cache = NULL;
node_context_cache = NULL;
if (dump_file)
fprintf (dump_file, "node context cache: %li hits, %li misses,"
" %li initializations\n",
node_context_cache_hit, node_context_cache_miss,
node_context_cache_clear);
node_context_cache_hit = 0;
node_context_cache_miss = 0;
node_context_cache_clear = 0;
}
/* Return hints derrived from EDGE. */
int
simple_edge_hints (struct cgraph_edge *edge)
{
int hints = 0;
struct cgraph_node *to = (edge->caller->inlined_to
? edge->caller->inlined_to : edge->caller);
struct cgraph_node *callee = edge->callee->ultimate_alias_target ();
int to_scc_no = ipa_fn_summaries->get (to)->scc_no;
int callee_scc_no = ipa_fn_summaries->get (callee)->scc_no;
if (to_scc_no && to_scc_no == callee_scc_no && !edge->recursive_p ())
hints |= INLINE_HINT_same_scc;
if (callee->lto_file_data && edge->caller->lto_file_data
&& edge->caller->lto_file_data != callee->lto_file_data
&& !callee->merged_comdat && !callee->icf_merged)
hints |= INLINE_HINT_cross_module;
return hints;
}
/* Estimate the time cost for the caller when inlining EDGE.
Only to be called via estimate_edge_time, that handles the
caching mechanism.
When caching, also update the cache entry. Compute both time and
size, since we always need both metrics eventually. */
sreal
do_estimate_edge_time (struct cgraph_edge *edge)
{
sreal time, nonspec_time;
int size;
ipa_hints hints;
struct cgraph_node *callee;
clause_t clause, nonspec_clause;
vec<tree> known_vals;
vec<ipa_polymorphic_call_context> known_contexts;
vec<ipa_agg_jump_function_p> known_aggs;
class ipa_call_summary *es = ipa_call_summaries->get (edge);
int min_size = -1;
callee = edge->callee->ultimate_alias_target ();
gcc_checking_assert (edge->inline_failed);
evaluate_properties_for_edge (edge, true,
&clause, &nonspec_clause, &known_vals,
&known_contexts, &known_aggs);
ipa_call_context ctx (callee, clause, nonspec_clause, known_vals,
known_contexts, known_aggs, es->param);
if (node_context_cache != NULL)
{
node_context_summary *e = node_context_cache->get_create (callee);
if (e->entry.ctx.equal_to (ctx))
{
node_context_cache_hit++;
size = e->entry.size;
time = e->entry.time;
nonspec_time = e->entry.nonspec_time;
hints = e->entry.hints;
}
else
{
if (e->entry.ctx.exists_p ())
node_context_cache_miss++;
else
node_context_cache_clear++;
e->entry.ctx.release (true);
ctx.estimate_size_and_time (&size, &min_size,
&time, &nonspec_time, &hints);
e->entry.size = size;
e->entry.time = time;
e->entry.nonspec_time = nonspec_time;
e->entry.hints = hints;
e->entry.ctx.duplicate_from (ctx);
}
}
else
ctx.estimate_size_and_time (&size, &min_size,
&time, &nonspec_time, &hints);
/* When we have profile feedback, we can quite safely identify hot
edges and for those we disable size limits. Don't do that when
probability that caller will call the callee is low however, since it
may hurt optimization of the caller's hot path. */
if (edge->count.ipa ().initialized_p () && edge->maybe_hot_p ()
&& (edge->count.ipa ().apply_scale (2, 1)
> (edge->caller->inlined_to
? edge->caller->inlined_to->count.ipa ()
: edge->caller->count.ipa ())))
hints |= INLINE_HINT_known_hot;
ctx.release ();
gcc_checking_assert (size >= 0);
gcc_checking_assert (time >= 0);
/* When caching, update the cache entry. */
if (edge_growth_cache != NULL)
{
if (min_size >= 0)
ipa_fn_summaries->get (edge->callee->function_symbol ())->min_size
= min_size;
edge_growth_cache_entry *entry
= edge_growth_cache->get_create (edge);
entry->time = time;
entry->nonspec_time = nonspec_time;
entry->size = size + (size >= 0);
hints |= simple_edge_hints (edge);
entry->hints = hints + 1;
}
return time;
}
/* Reset cache for NODE.
This must be done each time NODE body is modified. */
void
reset_node_cache (struct cgraph_node *node)
{
if (node_context_cache)
node_context_cache->remove (node);
}
/* Remove EDGE from caches once it was inlined. */
void
ipa_remove_from_growth_caches (struct cgraph_edge *edge)
{
if (node_context_cache)
node_context_cache->remove (edge->callee);
if (edge_growth_cache)
edge_growth_cache->remove (edge);
}
/* Return estimated callee growth after inlining EDGE.
Only to be called via estimate_edge_size. */
int
do_estimate_edge_size (struct cgraph_edge *edge)
{
int size;
struct cgraph_node *callee;
clause_t clause, nonspec_clause;
vec<tree> known_vals;
vec<ipa_polymorphic_call_context> known_contexts;
vec<ipa_agg_jump_function_p> known_aggs;
/* When we do caching, use do_estimate_edge_time to populate the entry. */
if (edge_growth_cache != NULL)
{
do_estimate_edge_time (edge);
size = edge_growth_cache->get (edge)->size;
gcc_checking_assert (size);
return size - (size > 0);
}
callee = edge->callee->ultimate_alias_target ();
/* Early inliner runs without caching, go ahead and do the dirty work. */
gcc_checking_assert (edge->inline_failed);
evaluate_properties_for_edge (edge, true,
&clause, &nonspec_clause,
&known_vals, &known_contexts,
&known_aggs);
ipa_call_context ctx (callee, clause, nonspec_clause, known_vals,
known_contexts, known_aggs, vNULL);
ctx.estimate_size_and_time (&size, NULL, NULL, NULL, NULL);
ctx.release ();
return size;
}
/* Estimate the growth of the caller when inlining EDGE.
Only to be called via estimate_edge_size. */
ipa_hints
do_estimate_edge_hints (struct cgraph_edge *edge)
{
ipa_hints hints;
struct cgraph_node *callee;
clause_t clause, nonspec_clause;
vec<tree> known_vals;
vec<ipa_polymorphic_call_context> known_contexts;
vec<ipa_agg_jump_function_p> known_aggs;
/* When we do caching, use do_estimate_edge_time to populate the entry. */
if (edge_growth_cache != NULL)
{
do_estimate_edge_time (edge);
hints = edge_growth_cache->get (edge)->hints;
gcc_checking_assert (hints);
return hints - 1;
}
callee = edge->callee->ultimate_alias_target ();
/* Early inliner runs without caching, go ahead and do the dirty work. */
gcc_checking_assert (edge->inline_failed);
evaluate_properties_for_edge (edge, true,
&clause, &nonspec_clause,
&known_vals, &known_contexts,
&known_aggs);
ipa_call_context ctx (callee, clause, nonspec_clause, known_vals,
known_contexts, known_aggs, vNULL);
ctx.estimate_size_and_time (NULL, NULL, NULL, NULL, &hints);
ctx.release ();
hints |= simple_edge_hints (edge);
return hints;
}
/* Estimate the size of NODE after inlining EDGE which should be an
edge to either NODE or a call inlined into NODE. */
int
estimate_size_after_inlining (struct cgraph_node *node,
struct cgraph_edge *edge)
{
class ipa_call_summary *es = ipa_call_summaries->get (edge);
ipa_size_summary *s = ipa_size_summaries->get (node);
if (!es->predicate || *es->predicate != false)
{
int size = s->size + estimate_edge_growth (edge);
gcc_assert (size >= 0);
return size;
}
return s->size;
}
struct growth_data
{
struct cgraph_node *node;
bool self_recursive;
bool uninlinable;
int growth;
int cap;
};
/* Worker for do_estimate_growth. Collect growth for all callers. */
static bool
do_estimate_growth_1 (struct cgraph_node *node, void *data)
{
struct cgraph_edge *e;
struct growth_data *d = (struct growth_data *) data;
for (e = node->callers; e; e = e->next_caller)
{
gcc_checking_assert (e->inline_failed);
if (cgraph_inline_failed_type (e->inline_failed) == CIF_FINAL_ERROR
|| !opt_for_fn (e->caller->decl, optimize))
{
d->uninlinable = true;
if (d->cap < INT_MAX)
return true;
continue;
}
if (e->recursive_p ())
{
d->self_recursive = true;
if (d->cap < INT_MAX)
return true;
continue;
}
d->growth += estimate_edge_growth (e);
if (d->growth > d->cap)
return true;
}
return false;
}
/* Return estimated savings for eliminating offline copy of NODE by inlining
it everywhere. */
static int
offline_size (struct cgraph_node *node, ipa_size_summary *info)
{
if (!DECL_EXTERNAL (node->decl))
{
if (node->will_be_removed_from_program_if_no_direct_calls_p ())
return info->size;
/* COMDAT functions are very often not shared across multiple units
since they come from various template instantiations.
Take this into account. */
else if (DECL_COMDAT (node->decl)
&& node->can_remove_if_no_direct_calls_p ())
return (info->size
* (100 - param_comdat_sharing_probability)
+ 50) / 100;
}
return 0;
}
/* Estimate the growth caused by inlining NODE into all callees. */
int
estimate_growth (struct cgraph_node *node)
{
struct growth_data d = { node, false, false, 0, INT_MAX };
ipa_size_summary *info = ipa_size_summaries->get (node);
if (node->call_for_symbol_and_aliases (do_estimate_growth_1, &d, true))
return 1;
/* For self recursive functions the growth estimation really should be
infinity. We don't want to return very large values because the growth
plays various roles in badness computation fractions. Be sure to not
return zero or negative growths. */
if (d.self_recursive)
d.growth = d.growth < info->size ? info->size : d.growth;
else if (!d.uninlinable)
d.growth -= offline_size (node, info);
return d.growth;
}
/* Verify if there are fewer than MAX_CALLERS. */
static bool
check_callers (cgraph_node *node, int *growth, int *n, int offline,
int min_size, struct cgraph_edge *known_edge)
{
ipa_ref *ref;
if (!node->can_remove_if_no_direct_calls_and_refs_p ())
return true;
for (cgraph_edge *e = node->callers; e; e = e->next_caller)
{
edge_growth_cache_entry *entry;
if (e == known_edge)
continue;
if (cgraph_inline_failed_type (e->inline_failed) == CIF_FINAL_ERROR)
return true;
if (edge_growth_cache != NULL
&& (entry = edge_growth_cache->get (e)) != NULL
&& entry->size != 0)
*growth += entry->size - (entry->size > 0);
else
{
class ipa_call_summary *es = ipa_call_summaries->get (e);
if (!es)
return true;
*growth += min_size - es->call_stmt_size;
if (--(*n) < 0)
return false;
}
if (*growth > offline)
return true;
}
if (*n > 0)
FOR_EACH_ALIAS (node, ref)
if (check_callers (dyn_cast <cgraph_node *> (ref->referring), growth, n,
offline, min_size, known_edge))
return true;
return false;
}
/* Decide if growth of NODE is positive. This is cheaper than calculating
actual growth. If edge growth of KNOWN_EDGE is known
it is passed by EDGE_GROWTH. */
bool
growth_positive_p (struct cgraph_node *node,
struct cgraph_edge * known_edge, int edge_growth)
{
struct cgraph_edge *e;
ipa_size_summary *s = ipa_size_summaries->get (node);
/* First quickly check if NODE is removable at all. */
int offline = offline_size (node, s);
if (offline <= 0 && known_edge && edge_growth > 0)
return true;
int min_size = ipa_fn_summaries->get (node)->min_size;
int n = 10;
int min_growth = known_edge ? edge_growth : 0;
for (e = node->callers; e; e = e->next_caller)
{
edge_growth_cache_entry *entry;
if (cgraph_inline_failed_type (e->inline_failed) == CIF_FINAL_ERROR)
return true;
if (e == known_edge)
continue;
if (edge_growth_cache != NULL
&& (entry = edge_growth_cache->get (e)) != NULL
&& entry->size != 0)
min_growth += entry->size - (entry->size > 0);
else
{
class ipa_call_summary *es = ipa_call_summaries->get (e);
if (!es)
return true;
min_growth += min_size - es->call_stmt_size;
if (--n <= 0)
break;
}
if (min_growth > offline)
return true;
}
ipa_ref *ref;
if (n > 0)
FOR_EACH_ALIAS (node, ref)
if (check_callers (dyn_cast <cgraph_node *> (ref->referring),
&min_growth, &n, offline, min_size, known_edge))
return true;
struct growth_data d = { node, false, false, 0, offline };
if (node->call_for_symbol_and_aliases (do_estimate_growth_1, &d, true))
return true;
if (d.self_recursive || d.uninlinable)
return true;
return (d.growth > offline);
}
|