1 /*
2 * Copyright (c) 2011, 2018, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23
24
25 package org.graalvm.compiler.phases.common.inlining.policy;
26
27 import static org.graalvm.compiler.core.common.GraalOptions.InlineEverything;
28 import static org.graalvm.compiler.core.common.GraalOptions.LimitInlinedInvokes;
29 import static org.graalvm.compiler.core.common.GraalOptions.MaximumDesiredSize;
30 import static org.graalvm.compiler.core.common.GraalOptions.MaximumInliningSize;
31 import static org.graalvm.compiler.core.common.GraalOptions.SmallCompiledLowLevelGraphSize;
32 import static org.graalvm.compiler.core.common.GraalOptions.TraceInlining;
33 import static org.graalvm.compiler.core.common.GraalOptions.TrivialInliningSize;
34
35 import java.util.Map;
36
37 import org.graalvm.compiler.debug.CounterKey;
38 import org.graalvm.compiler.debug.DebugContext;
39 import org.graalvm.compiler.nodes.Invoke;
40 import org.graalvm.compiler.nodes.StructuredGraph;
41 import org.graalvm.compiler.nodes.spi.Replacements;
42 import org.graalvm.compiler.options.OptionValues;
43 import org.graalvm.compiler.phases.common.inlining.InliningUtil;
44 import org.graalvm.compiler.phases.common.inlining.info.InlineInfo;
45 import org.graalvm.compiler.phases.common.inlining.walker.MethodInvocation;
46
47 public class GreedyInliningPolicy extends AbstractInliningPolicy {
48
49 private static final CounterKey inliningStoppedByMaxDesiredSizeCounter = DebugContext.counter("InliningStoppedByMaxDesiredSize");
50
51 public GreedyInliningPolicy(Map<Invoke, Double> hints) {
52 super(hints);
53 }
54
55 @Override
56 public boolean continueInlining(StructuredGraph currentGraph) {
57 if (InliningUtil.getNodeCount(currentGraph) >= MaximumDesiredSize.getValue(currentGraph.getOptions())) {
58 DebugContext debug = currentGraph.getDebug();
59 InliningUtil.logInliningDecision(debug, "inlining is cut off by MaximumDesiredSize");
60 inliningStoppedByMaxDesiredSizeCounter.increment(debug);
61 return false;
62 }
63 return true;
64 }
65
66 @Override
67 public Decision isWorthInlining(Replacements replacements, MethodInvocation invocation, InlineInfo calleeInfo, int inliningDepth, boolean fullyProcessed) {
68 OptionValues options = calleeInfo.graph().getOptions();
69 final boolean isTracing = TraceInlining.getValue(options);
70 final InlineInfo info = invocation.callee();
71 final double probability = invocation.probability();
72 final double relevance = invocation.relevance();
73
74 if (InlineEverything.getValue(options)) {
75 InliningUtil.traceInlinedMethod(info, inliningDepth, fullyProcessed, "inline everything");
76 return InliningPolicy.Decision.YES.withReason(isTracing, "inline everything");
77 }
78
79 if (isIntrinsic(replacements, info)) {
80 InliningUtil.traceInlinedMethod(info, inliningDepth, fullyProcessed, "intrinsic");
81 return InliningPolicy.Decision.YES.withReason(isTracing, "intrinsic");
82 }
83
84 if (info.shouldInline()) {
85 InliningUtil.traceInlinedMethod(info, inliningDepth, fullyProcessed, "forced inlining");
86 return InliningPolicy.Decision.YES.withReason(isTracing, "forced inlining");
87 }
88
89 double inliningBonus = getInliningBonus(info);
90 int nodes = info.determineNodeCount();
91 int lowLevelGraphSize = previousLowLevelGraphSize(info);
92
93 if (SmallCompiledLowLevelGraphSize.getValue(options) > 0 && lowLevelGraphSize > SmallCompiledLowLevelGraphSize.getValue(options) * inliningBonus) {
94 InliningUtil.traceNotInlinedMethod(info, inliningDepth, "too large previous low-level graph (low-level-nodes: %d, relevance=%f, probability=%f, bonus=%f, nodes=%d)", lowLevelGraphSize,
95 relevance, probability, inliningBonus, nodes);
96 return InliningPolicy.Decision.NO.withReason(isTracing, "too large previous low-level graph (low-level-nodes: %d, relevance=%f, probability=%f, bonus=%f, nodes=%d)", lowLevelGraphSize,
97 relevance, probability, inliningBonus, nodes);
98 }
99
100 if (nodes < TrivialInliningSize.getValue(options) * inliningBonus) {
101 InliningUtil.traceInlinedMethod(info, inliningDepth, fullyProcessed, "trivial (relevance=%f, probability=%f, bonus=%f, nodes=%d)", relevance, probability, inliningBonus, nodes);
102 return InliningPolicy.Decision.YES.withReason(isTracing, "trivial (relevance=%f, probability=%f, bonus=%f, nodes=%d)", relevance, probability, inliningBonus, nodes);
103 }
104
105 /*
106 * TODO (chaeubl): invoked methods that are on important paths but not yet compiled -> will
107 * be compiled anyways and it is likely that we are the only caller... might be useful to
108 * inline those methods but increases bootstrap time (maybe those methods are also getting
109 * queued in the compilation queue concurrently)
110 */
111 double invokes = determineInvokeProbability(info);
112 if (LimitInlinedInvokes.getValue(options) > 0 && fullyProcessed && invokes > LimitInlinedInvokes.getValue(options) * inliningBonus) {
113 InliningUtil.traceNotInlinedMethod(info, inliningDepth, "callee invoke probability is too high (invokeP=%f, relevance=%f, probability=%f, bonus=%f, nodes=%d)", invokes, relevance,
114 probability, inliningBonus, nodes);
115 return InliningPolicy.Decision.NO.withReason(isTracing, "callee invoke probability is too high (invokeP=%f, relevance=%f, probability=%f, bonus=%f, nodes=%d)", invokes, relevance,
116 probability, inliningBonus, nodes);
117 }
118
119 double maximumNodes = computeMaximumSize(relevance, (int) (MaximumInliningSize.getValue(options) * inliningBonus));
120 if (nodes <= maximumNodes) {
121 InliningUtil.traceInlinedMethod(info, inliningDepth, fullyProcessed, "relevance-based (relevance=%f, probability=%f, bonus=%f, nodes=%d <= %f)", relevance, probability, inliningBonus,
122 nodes, maximumNodes);
123 return InliningPolicy.Decision.YES.withReason(isTracing, "relevance-based (relevance=%f, probability=%f, bonus=%f, nodes=%d <= %f)", relevance, probability, inliningBonus,
124 nodes, maximumNodes);
125 }
126
127 InliningUtil.traceNotInlinedMethod(info, inliningDepth, "relevance-based (relevance=%f, probability=%f, bonus=%f, nodes=%d > %f)", relevance, probability, inliningBonus, nodes, maximumNodes);
128 return InliningPolicy.Decision.NO.withReason(isTracing, "relevance-based (relevance=%f, probability=%f, bonus=%f, nodes=%d > %f)", relevance, probability, inliningBonus, nodes, maximumNodes);
129 }
130 }