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.hotspot.phases;
26
27 import static org.graalvm.compiler.phases.common.DeadCodeEliminationPhase.Optionality.Required;
28
29 import org.graalvm.compiler.core.common.PermanentBailoutException;
30 import org.graalvm.compiler.core.common.cfg.Loop;
31 import org.graalvm.compiler.core.common.type.ObjectStamp;
32 import org.graalvm.compiler.core.common.type.Stamp;
33 import org.graalvm.compiler.debug.CounterKey;
34 import org.graalvm.compiler.debug.DebugCloseable;
35 import org.graalvm.compiler.debug.DebugContext;
36 import org.graalvm.compiler.debug.GraalError;
37 import org.graalvm.compiler.graph.Node;
38 import org.graalvm.compiler.graph.iterators.NodeIterable;
39 import org.graalvm.compiler.loop.LoopsData;
40 import org.graalvm.compiler.loop.phases.LoopTransformations;
41 import org.graalvm.compiler.nodeinfo.InputType;
42 import org.graalvm.compiler.nodeinfo.Verbosity;
43 import org.graalvm.compiler.nodes.AbstractBeginNode;
44 import org.graalvm.compiler.nodes.EntryMarkerNode;
45 import org.graalvm.compiler.nodes.EntryProxyNode;
46 import org.graalvm.compiler.nodes.FixedGuardNode;
47 import org.graalvm.compiler.nodes.FixedNode;
48 import org.graalvm.compiler.nodes.FrameState;
49 import org.graalvm.compiler.nodes.LogicNode;
50 import org.graalvm.compiler.nodes.LoopBeginNode;
51 import org.graalvm.compiler.nodes.NodeView;
52 import org.graalvm.compiler.nodes.ParameterNode;
53 import org.graalvm.compiler.nodes.PiNode;
54 import org.graalvm.compiler.nodes.StartNode;
55 import org.graalvm.compiler.nodes.StructuredGraph;
56 import org.graalvm.compiler.nodes.ValueNode;
57 import org.graalvm.compiler.nodes.cfg.Block;
58 import org.graalvm.compiler.nodes.extended.OSRLocalNode;
59 import org.graalvm.compiler.nodes.extended.OSRLockNode;
60 import org.graalvm.compiler.nodes.extended.OSRMonitorEnterNode;
61 import org.graalvm.compiler.nodes.extended.OSRStartNode;
62 import org.graalvm.compiler.nodes.java.AccessMonitorNode;
63 import org.graalvm.compiler.nodes.java.InstanceOfNode;
64 import org.graalvm.compiler.nodes.java.MonitorEnterNode;
65 import org.graalvm.compiler.nodes.java.MonitorExitNode;
66 import org.graalvm.compiler.nodes.java.MonitorIdNode;
67 import org.graalvm.compiler.nodes.util.GraphUtil;
68 import org.graalvm.compiler.options.Option;
69 import org.graalvm.compiler.options.OptionKey;
70 import org.graalvm.compiler.options.OptionType;
71 import org.graalvm.compiler.options.OptionValues;
72 import org.graalvm.compiler.phases.Phase;
73 import org.graalvm.compiler.phases.common.DeadCodeEliminationPhase;
74
75 import jdk.vm.ci.meta.DeoptimizationAction;
76 import jdk.vm.ci.meta.DeoptimizationReason;
77 import jdk.vm.ci.meta.JavaKind;
78 import jdk.vm.ci.meta.SpeculationLog;
79 import jdk.vm.ci.meta.SpeculationLog.SpeculationReason;
80 import jdk.vm.ci.runtime.JVMCICompiler;
81
82 public class OnStackReplacementPhase extends Phase {
83
84 public static class Options {
85 // @formatter:off
86 @Option(help = "Deoptimize OSR compiled code when the OSR entry loop is finished " +
87 "if there is no mature profile available for the rest of the method.", type = OptionType.Debug)
88 public static final OptionKey<Boolean> DeoptAfterOSR = new OptionKey<>(true);
89 @Option(help = "Support OSR compilations with locks. If DeoptAfterOSR is true we can per definition not have " +
90 "unbalaced enter/extis mappings. If DeoptAfterOSR is false insert artificial monitor enters after " +
91 "the OSRStart to have balanced enter/exits in the graph.", type = OptionType.Debug)
92 public static final OptionKey<Boolean> SupportOSRWithLocks = new OptionKey<>(true);
93 // @formatter:on
94 }
95
96 private static final CounterKey OsrWithLocksCount = DebugContext.counter("OSRWithLocks");
97
98 private static boolean supportOSRWithLocks(OptionValues options) {
99 return Options.SupportOSRWithLocks.getValue(options);
100 }
101
102 @Override
103 @SuppressWarnings("try")
104 protected void run(StructuredGraph graph) {
105 DebugContext debug = graph.getDebug();
106 if (graph.getEntryBCI() == JVMCICompiler.INVOCATION_ENTRY_BCI) {
107 // This happens during inlining in a OSR method, because the same phase plan will be
108 // used.
109 assert graph.getNodes(EntryMarkerNode.TYPE).isEmpty();
110 return;
111 }
112 debug.dump(DebugContext.DETAILED_LEVEL, graph, "OnStackReplacement initial at bci %d", graph.getEntryBCI());
113
114 EntryMarkerNode osr;
115 int maxIterations = -1;
116 int iterations = 0;
117
118 final EntryMarkerNode originalOSRNode = getEntryMarker(graph);
119 final LoopBeginNode originalOSRLoop = osrLoop(originalOSRNode);
120 final boolean currentOSRWithLocks = osrWithLocks(originalOSRNode);
121
135 do {
136 osr = getEntryMarker(graph);
137 LoopsData loops = new LoopsData(graph);
138 // Find the loop that contains the EntryMarker
139 Loop<Block> l = loops.getCFG().getNodeToBlock().get(osr).getLoop();
140 if (l == null) {
141 break;
142 }
143
144 iterations++;
145 if (maxIterations == -1) {
146 maxIterations = l.getDepth();
147 } else if (iterations > maxIterations) {
148 throw GraalError.shouldNotReachHere();
149 }
150 // Peel the outermost loop first
151 while (l.getParent() != null) {
152 l = l.getParent();
153 }
154
155 LoopTransformations.peel(loops.loop(l));
156 osr.replaceAtUsages(InputType.Guard, AbstractBeginNode.prevBegin((FixedNode) osr.predecessor()));
157 for (Node usage : osr.usages().snapshot()) {
158 EntryProxyNode proxy = (EntryProxyNode) usage;
159 proxy.replaceAndDelete(proxy.value());
160 }
161 GraphUtil.removeFixedWithUnusedInputs(osr);
162 debug.dump(DebugContext.DETAILED_LEVEL, graph, "OnStackReplacement loop peeling result");
163 } while (true);
164
165 StartNode start = graph.start();
166 FrameState osrState = osr.stateAfter();
167 OSRStartNode osrStart;
168 try (DebugCloseable context = osr.withNodeSourcePosition()) {
169 osr.setStateAfter(null);
170 osrStart = graph.add(new OSRStartNode());
171 FixedNode next = osr.next();
172 osr.setNext(null);
173 osrStart.setNext(next);
174 graph.setStart(osrStart);
175 osrStart.setStateAfter(osrState);
176
177 debug.dump(DebugContext.DETAILED_LEVEL, graph, "OnStackReplacement after setting OSR start");
178 final int localsSize = osrState.localsSize();
179 final int locksSize = osrState.locksSize();
180
181 for (int i = 0; i < localsSize + locksSize; i++) {
182 ValueNode value = null;
183 if (i >= localsSize) {
184 value = osrState.lockAt(i - localsSize);
185 } else {
186 value = osrState.localAt(i);
187 }
188 if (value instanceof EntryProxyNode) {
189 EntryProxyNode proxy = (EntryProxyNode) value;
190 /*
191 * We need to drop the stamp since the types we see during OSR may be too
192 * precise (if a branch was not parsed for example). In cases when this is
193 * possible, we insert a guard and narrow the OSRLocal stamp at its usages.
194 */
195 Stamp narrowedStamp = proxy.value().stamp(NodeView.DEFAULT);
196 Stamp unrestrictedStamp = proxy.stamp(NodeView.DEFAULT).unrestricted();
197 ValueNode osrLocal;
198 if (i >= localsSize) {
199 osrLocal = graph.addOrUnique(new OSRLockNode(i - localsSize, unrestrictedStamp));
200 } else {
201 osrLocal = graph.addOrUnique(new OSRLocalNode(i, unrestrictedStamp));
202 }
203 // Speculate on the OSRLocal stamps that could be more precise.
204 OSRLocalSpeculationReason reason = new OSRLocalSpeculationReason(osrState.bci, narrowedStamp, i);
205 if (graph.getSpeculationLog().maySpeculate(reason) && osrLocal instanceof OSRLocalNode && value.getStackKind().equals(JavaKind.Object) && !narrowedStamp.isUnrestricted()) {
206 // Add guard.
207 LogicNode check = graph.addOrUniqueWithInputs(InstanceOfNode.createHelper((ObjectStamp) narrowedStamp, osrLocal, null, null));
208 SpeculationLog.Speculation constant = graph.getSpeculationLog().speculate(reason);
209 FixedGuardNode guard = graph.add(new FixedGuardNode(check, DeoptimizationReason.OptimizedTypeCheckViolated, DeoptimizationAction.InvalidateRecompile, constant, false));
210 graph.addAfterFixed(osrStart, guard);
211
212 // Replace with a more specific type at usages.
213 // We know that we are at the root,
214 // so we need to replace the proxy in the state.
215 proxy.replaceAtMatchingUsages(osrLocal, n -> n == osrState);
216 osrLocal = graph.addOrUnique(new PiNode(osrLocal, narrowedStamp, guard));
217 }
218 proxy.replaceAndDelete(osrLocal);
219 } else {
220 assert value == null || value instanceof OSRLocalNode;
221 }
222 }
223
224 osr.replaceAtUsages(InputType.Guard, osrStart);
287 return osr;
288 }
289
290 private static LoopBeginNode osrLoop(EntryMarkerNode osr) {
291 // Check that there is an OSR loop for the OSR begin
292 LoopsData loops = new LoopsData(osr.graph());
293 Loop<Block> l = loops.getCFG().getNodeToBlock().get(osr).getLoop();
294 if (l == null) {
295 return null;
296 }
297 return (LoopBeginNode) l.getHeader().getBeginNode();
298 }
299
300 private static boolean osrWithLocks(EntryMarkerNode osr) {
301 return osr.stateAfter().locksSize() != 0;
302 }
303
304 @Override
305 public float codeSizeIncrease() {
306 return 5.0f;
307 }
308
309 private static class OSRLocalSpeculationReason implements SpeculationReason {
310 private int bci;
311 private Stamp speculatedStamp;
312 private int localIndex;
313
314 OSRLocalSpeculationReason(int bci, Stamp speculatedStamp, int localIndex) {
315 this.bci = bci;
316 this.speculatedStamp = speculatedStamp;
317 this.localIndex = localIndex;
318 }
319
320 @Override
321 public boolean equals(Object obj) {
322 if (obj instanceof OSRLocalSpeculationReason) {
323 OSRLocalSpeculationReason that = (OSRLocalSpeculationReason) obj;
324 return this.bci == that.bci && this.speculatedStamp.equals(that.speculatedStamp) && this.localIndex == that.localIndex;
325 }
326 return false;
327 }
328
329 @Override
330 public int hashCode() {
331 return (bci << 16) ^ speculatedStamp.hashCode() ^ localIndex;
332 }
333 }
334 }
|
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.hotspot.phases;
26
27 import static org.graalvm.compiler.phases.common.DeadCodeEliminationPhase.Optionality.Required;
28
29 import org.graalvm.compiler.core.common.PermanentBailoutException;
30 import org.graalvm.compiler.core.common.cfg.Loop;
31 import org.graalvm.compiler.core.common.type.ObjectStamp;
32 import org.graalvm.compiler.core.common.type.Stamp;
33 import org.graalvm.compiler.debug.CounterKey;
34 import org.graalvm.compiler.debug.DebugCloseable;
35 import org.graalvm.compiler.debug.DebugContext;
36 import org.graalvm.compiler.debug.GraalError;
37 import org.graalvm.compiler.graph.Node;
38 import org.graalvm.compiler.graph.iterators.NodeIterable;
39 import org.graalvm.compiler.loop.LoopEx;
40 import org.graalvm.compiler.loop.LoopsData;
41 import org.graalvm.compiler.loop.phases.LoopTransformations;
42 import org.graalvm.compiler.nodeinfo.InputType;
43 import org.graalvm.compiler.nodeinfo.Verbosity;
44 import org.graalvm.compiler.nodes.AbstractBeginNode;
45 import org.graalvm.compiler.nodes.EntryMarkerNode;
46 import org.graalvm.compiler.nodes.EntryProxyNode;
47 import org.graalvm.compiler.nodes.FixedGuardNode;
48 import org.graalvm.compiler.nodes.FixedNode;
49 import org.graalvm.compiler.nodes.FrameState;
50 import org.graalvm.compiler.nodes.LogicNode;
51 import org.graalvm.compiler.nodes.LoopBeginNode;
52 import org.graalvm.compiler.nodes.NodeView;
53 import org.graalvm.compiler.nodes.ParameterNode;
54 import org.graalvm.compiler.nodes.PiNode;
55 import org.graalvm.compiler.nodes.StartNode;
56 import org.graalvm.compiler.nodes.StructuredGraph;
57 import org.graalvm.compiler.nodes.ValueNode;
58 import org.graalvm.compiler.nodes.cfg.Block;
59 import org.graalvm.compiler.nodes.extended.OSRLocalNode;
60 import org.graalvm.compiler.nodes.extended.OSRLockNode;
61 import org.graalvm.compiler.nodes.extended.OSRMonitorEnterNode;
62 import org.graalvm.compiler.nodes.extended.OSRStartNode;
63 import org.graalvm.compiler.nodes.java.AccessMonitorNode;
64 import org.graalvm.compiler.nodes.java.InstanceOfNode;
65 import org.graalvm.compiler.nodes.java.MonitorEnterNode;
66 import org.graalvm.compiler.nodes.java.MonitorExitNode;
67 import org.graalvm.compiler.nodes.java.MonitorIdNode;
68 import org.graalvm.compiler.nodes.util.GraphUtil;
69 import org.graalvm.compiler.options.Option;
70 import org.graalvm.compiler.options.OptionKey;
71 import org.graalvm.compiler.options.OptionType;
72 import org.graalvm.compiler.options.OptionValues;
73 import org.graalvm.compiler.phases.Phase;
74 import org.graalvm.compiler.phases.common.DeadCodeEliminationPhase;
75 import org.graalvm.compiler.serviceprovider.SpeculationReasonGroup;
76
77 import jdk.vm.ci.meta.DeoptimizationAction;
78 import jdk.vm.ci.meta.DeoptimizationReason;
79 import jdk.vm.ci.meta.JavaKind;
80 import jdk.vm.ci.meta.SpeculationLog;
81 import jdk.vm.ci.meta.SpeculationLog.SpeculationReason;
82 import jdk.vm.ci.runtime.JVMCICompiler;
83
84 public class OnStackReplacementPhase extends Phase {
85
86 public static class Options {
87 // @formatter:off
88 @Option(help = "Deoptimize OSR compiled code when the OSR entry loop is finished " +
89 "if there is no mature profile available for the rest of the method.", type = OptionType.Debug)
90 public static final OptionKey<Boolean> DeoptAfterOSR = new OptionKey<>(true);
91 @Option(help = "Support OSR compilations with locks. If DeoptAfterOSR is true we can per definition not have " +
92 "unbalanced enter/exits mappings. If DeoptAfterOSR is false insert artificial monitor enters after " +
93 "the OSRStart to have balanced enter/exits in the graph.", type = OptionType.Debug)
94 public static final OptionKey<Boolean> SupportOSRWithLocks = new OptionKey<>(true);
95 // @formatter:on
96 }
97
98 private static final CounterKey OsrWithLocksCount = DebugContext.counter("OSRWithLocks");
99
100 private static boolean supportOSRWithLocks(OptionValues options) {
101 return Options.SupportOSRWithLocks.getValue(options);
102 }
103
104 private static final SpeculationReasonGroup OSR_LOCAL_SPECULATIONS = new SpeculationReasonGroup("OSRLocal", int.class, Stamp.class, int.class);
105
106 @Override
107 @SuppressWarnings("try")
108 protected void run(StructuredGraph graph) {
109 DebugContext debug = graph.getDebug();
110 if (graph.getEntryBCI() == JVMCICompiler.INVOCATION_ENTRY_BCI) {
111 // This happens during inlining in a OSR method, because the same phase plan will be
112 // used.
113 assert graph.getNodes(EntryMarkerNode.TYPE).isEmpty();
114 return;
115 }
116 debug.dump(DebugContext.DETAILED_LEVEL, graph, "OnStackReplacement initial at bci %d", graph.getEntryBCI());
117
118 EntryMarkerNode osr;
119 int maxIterations = -1;
120 int iterations = 0;
121
122 final EntryMarkerNode originalOSRNode = getEntryMarker(graph);
123 final LoopBeginNode originalOSRLoop = osrLoop(originalOSRNode);
124 final boolean currentOSRWithLocks = osrWithLocks(originalOSRNode);
125
139 do {
140 osr = getEntryMarker(graph);
141 LoopsData loops = new LoopsData(graph);
142 // Find the loop that contains the EntryMarker
143 Loop<Block> l = loops.getCFG().getNodeToBlock().get(osr).getLoop();
144 if (l == null) {
145 break;
146 }
147
148 iterations++;
149 if (maxIterations == -1) {
150 maxIterations = l.getDepth();
151 } else if (iterations > maxIterations) {
152 throw GraalError.shouldNotReachHere();
153 }
154 // Peel the outermost loop first
155 while (l.getParent() != null) {
156 l = l.getParent();
157 }
158
159 LoopEx loop = loops.loop(l);
160 loop.loopBegin().markOsrLoop();
161 LoopTransformations.peel(loop);
162 osr.replaceAtUsages(InputType.Guard, AbstractBeginNode.prevBegin((FixedNode) osr.predecessor()));
163 for (Node usage : osr.usages().snapshot()) {
164 EntryProxyNode proxy = (EntryProxyNode) usage;
165 proxy.replaceAndDelete(proxy.value());
166 }
167 GraphUtil.removeFixedWithUnusedInputs(osr);
168 debug.dump(DebugContext.DETAILED_LEVEL, graph, "OnStackReplacement loop peeling result");
169 } while (true);
170
171 StartNode start = graph.start();
172 FrameState osrState = osr.stateAfter();
173 OSRStartNode osrStart;
174 try (DebugCloseable context = osr.withNodeSourcePosition()) {
175 osr.setStateAfter(null);
176 osrStart = graph.add(new OSRStartNode());
177 FixedNode next = osr.next();
178 osr.setNext(null);
179 osrStart.setNext(next);
180 graph.setStart(osrStart);
181 osrStart.setStateAfter(osrState);
182
183 debug.dump(DebugContext.DETAILED_LEVEL, graph, "OnStackReplacement after setting OSR start");
184 final int localsSize = osrState.localsSize();
185 final int locksSize = osrState.locksSize();
186
187 for (int i = 0; i < localsSize + locksSize; i++) {
188 ValueNode value;
189 if (i >= localsSize) {
190 value = osrState.lockAt(i - localsSize);
191 } else {
192 value = osrState.localAt(i);
193 }
194 if (value instanceof EntryProxyNode) {
195 EntryProxyNode proxy = (EntryProxyNode) value;
196 /*
197 * We need to drop the stamp since the types we see during OSR may be too
198 * precise (if a branch was not parsed for example). In cases when this is
199 * possible, we insert a guard and narrow the OSRLocal stamp at its usages.
200 */
201 Stamp narrowedStamp = proxy.value().stamp(NodeView.DEFAULT);
202 Stamp unrestrictedStamp = proxy.stamp(NodeView.DEFAULT).unrestricted();
203 ValueNode osrLocal;
204 if (i >= localsSize) {
205 osrLocal = graph.addOrUnique(new OSRLockNode(i - localsSize, unrestrictedStamp));
206 } else {
207 osrLocal = graph.addOrUnique(new OSRLocalNode(i, unrestrictedStamp));
208 }
209 // Speculate on the OSRLocal stamps that could be more precise.
210 SpeculationReason reason = OSR_LOCAL_SPECULATIONS.createSpeculationReason(osrState.bci, narrowedStamp, i);
211 if (graph.getSpeculationLog().maySpeculate(reason) && osrLocal instanceof OSRLocalNode && value.getStackKind().equals(JavaKind.Object) && !narrowedStamp.isUnrestricted()) {
212 // Add guard.
213 LogicNode check = graph.addOrUniqueWithInputs(InstanceOfNode.createHelper((ObjectStamp) narrowedStamp, osrLocal, null, null));
214 SpeculationLog.Speculation constant = graph.getSpeculationLog().speculate(reason);
215 FixedGuardNode guard = graph.add(new FixedGuardNode(check, DeoptimizationReason.OptimizedTypeCheckViolated, DeoptimizationAction.InvalidateRecompile, constant, false));
216 graph.addAfterFixed(osrStart, guard);
217
218 // Replace with a more specific type at usages.
219 // We know that we are at the root,
220 // so we need to replace the proxy in the state.
221 proxy.replaceAtMatchingUsages(osrLocal, n -> n == osrState);
222 osrLocal = graph.addOrUnique(new PiNode(osrLocal, narrowedStamp, guard));
223 }
224 proxy.replaceAndDelete(osrLocal);
225 } else {
226 assert value == null || value instanceof OSRLocalNode;
227 }
228 }
229
230 osr.replaceAtUsages(InputType.Guard, osrStart);
293 return osr;
294 }
295
296 private static LoopBeginNode osrLoop(EntryMarkerNode osr) {
297 // Check that there is an OSR loop for the OSR begin
298 LoopsData loops = new LoopsData(osr.graph());
299 Loop<Block> l = loops.getCFG().getNodeToBlock().get(osr).getLoop();
300 if (l == null) {
301 return null;
302 }
303 return (LoopBeginNode) l.getHeader().getBeginNode();
304 }
305
306 private static boolean osrWithLocks(EntryMarkerNode osr) {
307 return osr.stateAfter().locksSize() != 0;
308 }
309
310 @Override
311 public float codeSizeIncrease() {
312 return 5.0f;
313 }
314 }
|