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.replacements;
26
27 import static jdk.vm.ci.code.MemoryBarriers.JMM_POST_VOLATILE_READ;
28 import static jdk.vm.ci.code.MemoryBarriers.JMM_POST_VOLATILE_WRITE;
29 import static jdk.vm.ci.code.MemoryBarriers.JMM_PRE_VOLATILE_READ;
30 import static jdk.vm.ci.code.MemoryBarriers.JMM_PRE_VOLATILE_WRITE;
31 import static jdk.vm.ci.meta.DeoptimizationAction.InvalidateReprofile;
32 import static jdk.vm.ci.meta.DeoptimizationReason.BoundsCheckException;
33 import static jdk.vm.ci.meta.DeoptimizationReason.NullCheckException;
34 import static org.graalvm.compiler.core.common.SpeculativeExecutionAttacksMitigations.Options.UseIndexMasking;
35 import static org.graalvm.compiler.nodes.NamedLocationIdentity.ARRAY_LENGTH_LOCATION;
36 import static org.graalvm.compiler.nodes.calc.BinaryArithmeticNode.branchlessMax;
37 import static org.graalvm.compiler.nodes.calc.BinaryArithmeticNode.branchlessMin;
38 import static org.graalvm.compiler.nodes.java.ArrayLengthNode.readArrayLength;
39 import static org.graalvm.compiler.nodes.util.GraphUtil.skipPiWhileNonNull;
40
41 import java.nio.ByteOrder;
42 import java.util.ArrayList;
43 import java.util.BitSet;
44 import java.util.List;
45
46 import org.graalvm.compiler.api.directives.GraalDirectives;
47 import org.graalvm.compiler.api.replacements.Snippet;
48 import org.graalvm.compiler.api.replacements.SnippetReflectionProvider;
49 import org.graalvm.compiler.core.common.LIRKind;
50 import org.graalvm.compiler.core.common.spi.ForeignCallsProvider;
51 import org.graalvm.compiler.core.common.type.IntegerStamp;
52 import org.graalvm.compiler.core.common.type.ObjectStamp;
53 import org.graalvm.compiler.core.common.type.Stamp;
54 import org.graalvm.compiler.core.common.type.StampFactory;
55 import org.graalvm.compiler.core.common.type.TypeReference;
56 import org.graalvm.compiler.debug.DebugCloseable;
57 import org.graalvm.compiler.debug.DebugHandlersFactory;
58 import org.graalvm.compiler.debug.GraalError;
59 import org.graalvm.compiler.graph.Node;
60 import org.graalvm.compiler.nodeinfo.InputType;
61 import org.graalvm.compiler.nodes.CompressionNode.CompressionOp;
62 import org.graalvm.compiler.nodes.ConstantNode;
63 import org.graalvm.compiler.nodes.FieldLocationIdentity;
64 import org.graalvm.compiler.nodes.FixedNode;
65 import org.graalvm.compiler.nodes.LogicNode;
66 import org.graalvm.compiler.nodes.NamedLocationIdentity;
67 import org.graalvm.compiler.nodes.NodeView;
68 import org.graalvm.compiler.nodes.PiNode;
69 import org.graalvm.compiler.nodes.StructuredGraph;
70 import org.graalvm.compiler.nodes.ValueNode;
71 import org.graalvm.compiler.nodes.calc.AddNode;
72 import org.graalvm.compiler.nodes.calc.ConditionalNode;
73 import org.graalvm.compiler.nodes.calc.IntegerBelowNode;
74 import org.graalvm.compiler.nodes.calc.IntegerConvertNode;
75 import org.graalvm.compiler.nodes.calc.IntegerEqualsNode;
76 import org.graalvm.compiler.nodes.calc.IsNullNode;
77 import org.graalvm.compiler.nodes.calc.LeftShiftNode;
78 import org.graalvm.compiler.nodes.calc.NarrowNode;
79 import org.graalvm.compiler.nodes.calc.RightShiftNode;
80 import org.graalvm.compiler.nodes.calc.SignExtendNode;
81 import org.graalvm.compiler.nodes.calc.SubNode;
82 import org.graalvm.compiler.nodes.calc.UnpackEndianHalfNode;
83 import org.graalvm.compiler.nodes.calc.ZeroExtendNode;
84 import org.graalvm.compiler.nodes.debug.VerifyHeapNode;
85 import org.graalvm.compiler.nodes.extended.BoxNode;
86 import org.graalvm.compiler.nodes.extended.FixedValueAnchorNode;
87 import org.graalvm.compiler.nodes.extended.ForeignCallNode;
88 import org.graalvm.compiler.nodes.extended.GuardedUnsafeLoadNode;
89 import org.graalvm.compiler.nodes.extended.GuardingNode;
90 import org.graalvm.compiler.nodes.extended.JavaReadNode;
91 import org.graalvm.compiler.nodes.extended.JavaWriteNode;
92 import org.graalvm.compiler.nodes.extended.LoadArrayComponentHubNode;
93 import org.graalvm.compiler.nodes.extended.LoadHubNode;
94 import org.graalvm.compiler.nodes.extended.MembarNode;
95 import org.graalvm.compiler.nodes.extended.RawLoadNode;
96 import org.graalvm.compiler.nodes.extended.RawStoreNode;
97 import org.graalvm.compiler.nodes.extended.UnboxNode;
98 import org.graalvm.compiler.nodes.extended.UnsafeMemoryLoadNode;
99 import org.graalvm.compiler.nodes.extended.UnsafeMemoryStoreNode;
100 import org.graalvm.compiler.nodes.java.AbstractNewObjectNode;
101 import org.graalvm.compiler.nodes.java.AccessIndexedNode;
102 import org.graalvm.compiler.nodes.java.ArrayLengthNode;
103 import org.graalvm.compiler.nodes.java.AtomicReadAndWriteNode;
104 import org.graalvm.compiler.nodes.java.FinalFieldBarrierNode;
105 import org.graalvm.compiler.nodes.java.InstanceOfDynamicNode;
106 import org.graalvm.compiler.nodes.java.InstanceOfNode;
107 import org.graalvm.compiler.nodes.java.LoadFieldNode;
108 import org.graalvm.compiler.nodes.java.LoadIndexedNode;
109 import org.graalvm.compiler.nodes.java.LogicCompareAndSwapNode;
110 import org.graalvm.compiler.nodes.java.LoweredAtomicReadAndWriteNode;
111 import org.graalvm.compiler.nodes.java.MonitorEnterNode;
112 import org.graalvm.compiler.nodes.java.MonitorIdNode;
113 import org.graalvm.compiler.nodes.java.NewArrayNode;
114 import org.graalvm.compiler.nodes.java.NewInstanceNode;
115 import org.graalvm.compiler.nodes.java.RawMonitorEnterNode;
116 import org.graalvm.compiler.nodes.java.StoreFieldNode;
117 import org.graalvm.compiler.nodes.java.StoreIndexedNode;
118 import org.graalvm.compiler.nodes.java.UnsafeCompareAndExchangeNode;
119 import org.graalvm.compiler.nodes.java.UnsafeCompareAndSwapNode;
120 import org.graalvm.compiler.nodes.java.ValueCompareAndSwapNode;
121 import org.graalvm.compiler.nodes.memory.HeapAccess.BarrierType;
122 import org.graalvm.compiler.nodes.memory.ReadNode;
123 import org.graalvm.compiler.nodes.memory.WriteNode;
124 import org.graalvm.compiler.nodes.memory.address.AddressNode;
125 import org.graalvm.compiler.nodes.memory.address.IndexAddressNode;
126 import org.graalvm.compiler.nodes.memory.address.OffsetAddressNode;
127 import org.graalvm.compiler.nodes.spi.Lowerable;
128 import org.graalvm.compiler.nodes.spi.LoweringProvider;
129 import org.graalvm.compiler.nodes.spi.LoweringTool;
130 import org.graalvm.compiler.nodes.type.StampTool;
131 import org.graalvm.compiler.nodes.util.GraphUtil;
132 import org.graalvm.compiler.nodes.virtual.AllocatedObjectNode;
133 import org.graalvm.compiler.nodes.virtual.CommitAllocationNode;
134 import org.graalvm.compiler.nodes.virtual.VirtualArrayNode;
135 import org.graalvm.compiler.nodes.virtual.VirtualInstanceNode;
136 import org.graalvm.compiler.nodes.virtual.VirtualObjectNode;
137 import org.graalvm.compiler.options.OptionValues;
138 import org.graalvm.compiler.phases.util.Providers;
139 import org.graalvm.compiler.replacements.SnippetLowerableMemoryNode.SnippetLowering;
140 import org.graalvm.compiler.replacements.nodes.BinaryMathIntrinsicNode;
141 import org.graalvm.compiler.replacements.nodes.UnaryMathIntrinsicNode;
142 import jdk.internal.vm.compiler.word.LocationIdentity;
143
144 import jdk.vm.ci.code.CodeUtil;
145 import jdk.vm.ci.code.MemoryBarriers;
146 import jdk.vm.ci.code.TargetDescription;
147 import jdk.vm.ci.meta.DeoptimizationAction;
148 import jdk.vm.ci.meta.DeoptimizationReason;
149 import jdk.vm.ci.meta.JavaKind;
150 import jdk.vm.ci.meta.MetaAccessProvider;
151 import jdk.vm.ci.meta.ResolvedJavaField;
152 import jdk.vm.ci.meta.ResolvedJavaMethod;
153 import jdk.vm.ci.meta.ResolvedJavaType;
154 import jdk.vm.ci.meta.SpeculationLog;
155
156 /**
157 * VM-independent lowerings for standard Java nodes. VM-specific methods are abstract and must be
158 * implemented by VM-specific subclasses.
159 */
160 public abstract class DefaultJavaLoweringProvider implements LoweringProvider {
161
162 protected final MetaAccessProvider metaAccess;
163 protected final ForeignCallsProvider foreignCalls;
164 protected final TargetDescription target;
165 private final boolean useCompressedOops;
166 private final ResolvedJavaType objectArrayType;
167
168 private BoxingSnippets.Templates boxingSnippets;
169 private ConstantStringIndexOfSnippets.Templates indexOfSnippets;
170
171 public DefaultJavaLoweringProvider(MetaAccessProvider metaAccess, ForeignCallsProvider foreignCalls, TargetDescription target, boolean useCompressedOops) {
172 this.metaAccess = metaAccess;
173 this.foreignCalls = foreignCalls;
174 this.target = target;
175 this.useCompressedOops = useCompressedOops;
176 this.objectArrayType = metaAccess.lookupJavaType(Object[].class);
177 }
178
179 public void initialize(OptionValues options, Iterable<DebugHandlersFactory> factories, SnippetCounter.Group.Factory factory, Providers providers, SnippetReflectionProvider snippetReflection) {
180 boxingSnippets = new BoxingSnippets.Templates(options, factories, factory, providers, snippetReflection, target);
181 indexOfSnippets = new ConstantStringIndexOfSnippets.Templates(options, factories, providers, snippetReflection, target);
182 providers.getReplacements().registerSnippetTemplateCache(new SnippetCounterNode.SnippetCounterSnippets.Templates(options, factories, providers, snippetReflection, target));
183 }
184
185 public final TargetDescription getTarget() {
186 return target;
187 }
188
189 public MetaAccessProvider getMetaAccess() {
190 return metaAccess;
191 }
192
193 @Override
194 @SuppressWarnings("try")
195 public void lower(Node n, LoweringTool tool) {
196 assert n instanceof Lowerable;
197 StructuredGraph graph = (StructuredGraph) n.graph();
198 try (DebugCloseable context = n.withNodeSourcePosition()) {
199 if (n instanceof LoadFieldNode) {
200 lowerLoadFieldNode((LoadFieldNode) n, tool);
201 } else if (n instanceof StoreFieldNode) {
202 lowerStoreFieldNode((StoreFieldNode) n, tool);
203 } else if (n instanceof LoadIndexedNode) {
204 lowerLoadIndexedNode((LoadIndexedNode) n, tool);
205 } else if (n instanceof StoreIndexedNode) {
206 lowerStoreIndexedNode((StoreIndexedNode) n, tool);
207 } else if (n instanceof IndexAddressNode) {
208 lowerIndexAddressNode((IndexAddressNode) n);
209 } else if (n instanceof ArrayLengthNode) {
210 lowerArrayLengthNode((ArrayLengthNode) n, tool);
211 } else if (n instanceof LoadHubNode) {
212 lowerLoadHubNode((LoadHubNode) n, tool);
213 } else if (n instanceof LoadArrayComponentHubNode) {
214 lowerLoadArrayComponentHubNode((LoadArrayComponentHubNode) n);
215 } else if (n instanceof MonitorEnterNode) {
216 lowerMonitorEnterNode((MonitorEnterNode) n, tool, graph);
217 } else if (n instanceof UnsafeCompareAndSwapNode) {
218 lowerCompareAndSwapNode((UnsafeCompareAndSwapNode) n);
219 } else if (n instanceof UnsafeCompareAndExchangeNode) {
220 lowerCompareAndExchangeNode((UnsafeCompareAndExchangeNode) n);
221 } else if (n instanceof AtomicReadAndWriteNode) {
222 lowerAtomicReadAndWriteNode((AtomicReadAndWriteNode) n);
223 } else if (n instanceof RawLoadNode) {
224 lowerUnsafeLoadNode((RawLoadNode) n, tool);
225 } else if (n instanceof UnsafeMemoryLoadNode) {
226 lowerUnsafeMemoryLoadNode((UnsafeMemoryLoadNode) n);
227 } else if (n instanceof RawStoreNode) {
228 lowerUnsafeStoreNode((RawStoreNode) n);
229 } else if (n instanceof UnsafeMemoryStoreNode) {
230 lowerUnsafeMemoryStoreNode((UnsafeMemoryStoreNode) n);
231 } else if (n instanceof JavaReadNode) {
232 lowerJavaReadNode((JavaReadNode) n);
233 } else if (n instanceof JavaWriteNode) {
234 lowerJavaWriteNode((JavaWriteNode) n);
235 } else if (n instanceof CommitAllocationNode) {
236 lowerCommitAllocationNode((CommitAllocationNode) n, tool);
237 } else if (n instanceof BoxNode) {
238 boxingSnippets.lower((BoxNode) n, tool);
239 } else if (n instanceof UnboxNode) {
240 boxingSnippets.lower((UnboxNode) n, tool);
241 } else if (n instanceof VerifyHeapNode) {
242 lowerVerifyHeap((VerifyHeapNode) n);
243 } else if (n instanceof UnaryMathIntrinsicNode) {
244 lowerUnaryMath((UnaryMathIntrinsicNode) n, tool);
245 } else if (n instanceof BinaryMathIntrinsicNode) {
246 lowerBinaryMath((BinaryMathIntrinsicNode) n, tool);
247 } else if (n instanceof StringIndexOfNode) {
248 lowerIndexOf((StringIndexOfNode) n);
249 } else if (n instanceof StringLatin1IndexOfNode) {
250 lowerLatin1IndexOf((StringLatin1IndexOfNode) n);
251 } else if (n instanceof StringUTF16IndexOfNode) {
252 lowerUTF16IndexOf((StringUTF16IndexOfNode) n);
253 } else if (n instanceof UnpackEndianHalfNode) {
254 lowerSecondHalf((UnpackEndianHalfNode) n);
255 } else {
256 throw GraalError.shouldNotReachHere("Node implementing Lowerable not handled: " + n);
257 }
258 }
259 }
260
261 private void lowerSecondHalf(UnpackEndianHalfNode n) {
262 ByteOrder byteOrder = target.arch.getByteOrder();
263 n.lower(byteOrder);
264 }
265
266 private void lowerIndexOf(StringIndexOfNode n) {
267 if (n.getArgument(3).isConstant()) {
268 SnippetLowering lowering = new SnippetLowering() {
269 @Override
270 public void lower(SnippetLowerableMemoryNode node, LoweringTool tool) {
271 if (tool.getLoweringStage() != LoweringTool.StandardLoweringStage.LOW_TIER) {
272 return;
273 }
274 indexOfSnippets.lower(node, tool);
275 }
276 };
277 SnippetLowerableMemoryNode snippetLower = new SnippetLowerableMemoryNode(lowering, NamedLocationIdentity.getArrayLocation(JavaKind.Char), n.stamp(NodeView.DEFAULT), n.toArgumentArray());
278 n.graph().add(snippetLower);
279 n.graph().replaceFixedWithFixed(n, snippetLower);
280 }
281 }
282
283 private void lowerLatin1IndexOf(StringLatin1IndexOfNode n) {
284 if (n.getArgument(2).isConstant()) {
285 SnippetLowering lowering = new SnippetLowering() {
286 @Override
287 public void lower(SnippetLowerableMemoryNode node, LoweringTool tool) {
288 if (tool.getLoweringStage() != LoweringTool.StandardLoweringStage.LOW_TIER) {
289 return;
290 }
291 indexOfSnippets.lowerLatin1(node, tool);
292 }
293 };
294 SnippetLowerableMemoryNode snippetLower = new SnippetLowerableMemoryNode(lowering, NamedLocationIdentity.getArrayLocation(JavaKind.Byte), n.stamp(NodeView.DEFAULT), n.toArgumentArray());
295 n.graph().add(snippetLower);
296 n.graph().replaceFixedWithFixed(n, snippetLower);
297 }
298 }
299
300 private void lowerUTF16IndexOf(StringUTF16IndexOfNode n) {
301 if (n.getArgument(2).isConstant()) {
302 SnippetLowering lowering = new SnippetLowering() {
303 @Override
304 public void lower(SnippetLowerableMemoryNode node, LoweringTool tool) {
305 if (tool.getLoweringStage() != LoweringTool.StandardLoweringStage.LOW_TIER) {
306 return;
307 }
308 indexOfSnippets.lowerUTF16(node, tool);
309 }
310 };
311 SnippetLowerableMemoryNode snippetLower = new SnippetLowerableMemoryNode(lowering, NamedLocationIdentity.getArrayLocation(JavaKind.Byte), n.stamp(NodeView.DEFAULT), n.toArgumentArray());
312 n.graph().add(snippetLower);
313 n.graph().replaceFixedWithFixed(n, snippetLower);
314 }
315 }
316
317 private void lowerBinaryMath(BinaryMathIntrinsicNode math, LoweringTool tool) {
318 if (tool.getLoweringStage() == LoweringTool.StandardLoweringStage.HIGH_TIER) {
319 return;
320 }
321 ResolvedJavaMethod method = math.graph().method();
322 if (method != null) {
323 if (method.getAnnotation(Snippet.class) != null) {
324 // In the context of SnippetStub, i.e., Graal-generated stubs, use the LIR
325 // lowering to emit the stub assembly code instead of the Node lowering.
326 return;
327 }
328 if (method.getName().equalsIgnoreCase(math.getOperation().name()) && tool.getMetaAccess().lookupJavaType(Math.class).equals(method.getDeclaringClass())) {
329 // A root compilation of the intrinsic method should emit the full assembly
330 // implementation.
331 return;
332 }
333 }
334 StructuredGraph graph = math.graph();
335 ForeignCallNode call = graph.add(new ForeignCallNode(foreignCalls, math.getOperation().foreignCallDescriptor, math.getX(), math.getY()));
336 graph.addAfterFixed(tool.lastFixedNode(), call);
337 math.replaceAtUsages(call);
338 }
339
340 private void lowerUnaryMath(UnaryMathIntrinsicNode math, LoweringTool tool) {
341 if (tool.getLoweringStage() == LoweringTool.StandardLoweringStage.HIGH_TIER) {
342 return;
343 }
344 ResolvedJavaMethod method = math.graph().method();
345 if (method != null) {
346 if (method.getName().equalsIgnoreCase(math.getOperation().name()) && tool.getMetaAccess().lookupJavaType(Math.class).equals(method.getDeclaringClass())) {
347 // A root compilation of the intrinsic method should emit the full assembly
348 // implementation.
349 return;
350 }
351 }
352 StructuredGraph graph = math.graph();
353 ForeignCallNode call = math.graph().add(new ForeignCallNode(foreignCalls, math.getOperation().foreignCallDescriptor, math.getValue()));
354 graph.addAfterFixed(tool.lastFixedNode(), call);
355 math.replaceAtUsages(call);
356 }
357
358 protected void lowerVerifyHeap(VerifyHeapNode n) {
359 GraphUtil.removeFixedWithUnusedInputs(n);
360 }
361
362 protected AddressNode createOffsetAddress(StructuredGraph graph, ValueNode object, long offset) {
363 ValueNode o = ConstantNode.forIntegerKind(target.wordJavaKind, offset, graph);
364 return graph.unique(new OffsetAddressNode(object, o));
365 }
366
367 protected AddressNode createFieldAddress(StructuredGraph graph, ValueNode object, ResolvedJavaField field) {
368 int offset = fieldOffset(field);
369 if (offset >= 0) {
370 return createOffsetAddress(graph, object, offset);
371 } else {
372 return null;
373 }
374 }
375
376 protected abstract JavaKind getStorageKind(ResolvedJavaField field);
377
378 protected void lowerLoadFieldNode(LoadFieldNode loadField, LoweringTool tool) {
379 assert loadField.getStackKind() != JavaKind.Illegal;
380 StructuredGraph graph = loadField.graph();
381 ResolvedJavaField field = loadField.field();
382 ValueNode object = loadField.isStatic() ? staticFieldBase(graph, field) : loadField.object();
383 object = createNullCheckedValue(object, loadField, tool);
384 Stamp loadStamp = loadStamp(loadField.stamp(NodeView.DEFAULT), getStorageKind(field));
385
386 AddressNode address = createFieldAddress(graph, object, field);
387 assert address != null : "Field that is loaded must not be eliminated: " + field.getDeclaringClass().toJavaName(true) + "." + field.getName();
388
389 ReadNode memoryRead = graph.add(new ReadNode(address, fieldLocationIdentity(field), loadStamp, fieldLoadBarrierType(field)));
390 ValueNode readValue = implicitLoadConvert(graph, getStorageKind(field), memoryRead);
391 loadField.replaceAtUsages(readValue);
392 graph.replaceFixed(loadField, memoryRead);
393
394 if (loadField.isVolatile()) {
395 MembarNode preMembar = graph.add(new MembarNode(JMM_PRE_VOLATILE_READ));
396 graph.addBeforeFixed(memoryRead, preMembar);
397 MembarNode postMembar = graph.add(new MembarNode(JMM_POST_VOLATILE_READ));
398 graph.addAfterFixed(memoryRead, postMembar);
399 }
400 }
401
402 protected void lowerStoreFieldNode(StoreFieldNode storeField, LoweringTool tool) {
403 StructuredGraph graph = storeField.graph();
404 ResolvedJavaField field = storeField.field();
405 ValueNode object = storeField.isStatic() ? staticFieldBase(graph, field) : storeField.object();
406 object = createNullCheckedValue(object, storeField, tool);
407 ValueNode value = implicitStoreConvert(graph, getStorageKind(storeField.field()), storeField.value());
408 AddressNode address = createFieldAddress(graph, object, field);
409 assert address != null;
410
411 WriteNode memoryWrite = graph.add(new WriteNode(address, fieldLocationIdentity(field), value, fieldStoreBarrierType(storeField.field())));
412 memoryWrite.setStateAfter(storeField.stateAfter());
413 graph.replaceFixedWithFixed(storeField, memoryWrite);
414
415 if (storeField.isVolatile()) {
416 MembarNode preMembar = graph.add(new MembarNode(JMM_PRE_VOLATILE_WRITE));
417 graph.addBeforeFixed(memoryWrite, preMembar);
418 MembarNode postMembar = graph.add(new MembarNode(JMM_POST_VOLATILE_WRITE));
419 graph.addAfterFixed(memoryWrite, postMembar);
420 }
421 }
422
423 public static final IntegerStamp POSITIVE_ARRAY_INDEX_STAMP = StampFactory.forInteger(32, 0, Integer.MAX_VALUE - 1);
424
425 /**
426 * Create a PiNode on the index proving that the index is positive. On some platforms this is
427 * important to allow the index to be used as an int in the address mode.
428 */
429 public AddressNode createArrayIndexAddress(StructuredGraph graph, ValueNode array, JavaKind elementKind, ValueNode index, GuardingNode boundsCheck) {
430 ValueNode positiveIndex = graph.maybeAddOrUnique(PiNode.create(index, POSITIVE_ARRAY_INDEX_STAMP, boundsCheck != null ? boundsCheck.asNode() : null));
431 return createArrayAddress(graph, array, elementKind, positiveIndex);
432 }
433
434 public AddressNode createArrayAddress(StructuredGraph graph, ValueNode array, JavaKind elementKind, ValueNode index) {
435 ValueNode wordIndex;
436 if (target.wordSize > 4) {
437 wordIndex = graph.unique(new SignExtendNode(index, target.wordSize * 8));
438 } else {
439 assert target.wordSize == 4 : "unsupported word size";
440 wordIndex = index;
441 }
442
443 int shift = CodeUtil.log2(metaAccess.getArrayIndexScale(elementKind));
444 ValueNode scaledIndex = graph.unique(new LeftShiftNode(wordIndex, ConstantNode.forInt(shift, graph)));
445
446 int base = metaAccess.getArrayBaseOffset(elementKind);
447 ValueNode offset = graph.unique(new AddNode(scaledIndex, ConstantNode.forIntegerKind(target.wordJavaKind, base, graph)));
448
449 return graph.unique(new OffsetAddressNode(array, offset));
450 }
451
452 protected void lowerIndexAddressNode(IndexAddressNode indexAddress) {
453 AddressNode lowered = createArrayAddress(indexAddress.graph(), indexAddress.getArray(), indexAddress.getElementKind(), indexAddress.getIndex());
454 indexAddress.replaceAndDelete(lowered);
455 }
456
457 protected void lowerLoadIndexedNode(LoadIndexedNode loadIndexed, LoweringTool tool) {
458 StructuredGraph graph = loadIndexed.graph();
459 ValueNode array = loadIndexed.array();
460 array = createNullCheckedValue(array, loadIndexed, tool);
461 JavaKind elementKind = loadIndexed.elementKind();
462 Stamp loadStamp = loadStamp(loadIndexed.stamp(NodeView.DEFAULT), elementKind);
463
464 GuardingNode boundsCheck = getBoundsCheck(loadIndexed, array, tool);
465 ValueNode index = loadIndexed.index();
466 if (UseIndexMasking.getValue(graph.getOptions())) {
467 index = proxyIndex(loadIndexed, index, array, tool);
468 }
469 AddressNode address = createArrayIndexAddress(graph, array, elementKind, index, boundsCheck);
470
471 ReadNode memoryRead = graph.add(new ReadNode(address, NamedLocationIdentity.getArrayLocation(elementKind), loadStamp, BarrierType.NONE));
472 memoryRead.setGuard(boundsCheck);
473 ValueNode readValue = implicitLoadConvert(graph, elementKind, memoryRead);
474
475 loadIndexed.replaceAtUsages(readValue);
476 graph.replaceFixed(loadIndexed, memoryRead);
477 }
478
479 protected void lowerStoreIndexedNode(StoreIndexedNode storeIndexed, LoweringTool tool) {
480 StructuredGraph graph = storeIndexed.graph();
481
482 ValueNode value = storeIndexed.value();
483 ValueNode array = storeIndexed.array();
484
485 array = this.createNullCheckedValue(array, storeIndexed, tool);
486
487 GuardingNode boundsCheck = getBoundsCheck(storeIndexed, array, tool);
488
489 JavaKind elementKind = storeIndexed.elementKind();
490
491 LogicNode condition = null;
492 if (storeIndexed.getStoreCheck() == null && elementKind == JavaKind.Object && !StampTool.isPointerAlwaysNull(value)) {
493 /* Array store check. */
494 TypeReference arrayType = StampTool.typeReferenceOrNull(array);
495 if (arrayType != null && arrayType.isExact()) {
496 ResolvedJavaType elementType = arrayType.getType().getComponentType();
497 if (!elementType.isJavaLangObject()) {
498 TypeReference typeReference = TypeReference.createTrusted(storeIndexed.graph().getAssumptions(), elementType);
499 LogicNode typeTest = graph.addOrUniqueWithInputs(InstanceOfNode.create(typeReference, value));
500 condition = LogicNode.or(graph.unique(IsNullNode.create(value)), typeTest, GraalDirectives.UNLIKELY_PROBABILITY);
501 }
502 } else {
503 /*
504 * The guard on the read hub should be the null check of the array that was
505 * introduced earlier.
506 */
507 ValueNode arrayClass = createReadHub(graph, array, tool);
508 ValueNode componentHub = createReadArrayComponentHub(graph, arrayClass, storeIndexed);
509 LogicNode typeTest = graph.unique(InstanceOfDynamicNode.create(graph.getAssumptions(), tool.getConstantReflection(), componentHub, value, false));
510 condition = LogicNode.or(graph.unique(IsNullNode.create(value)), typeTest, GraalDirectives.UNLIKELY_PROBABILITY);
511 }
512 }
513
514 AddressNode address = createArrayIndexAddress(graph, array, elementKind, storeIndexed.index(), boundsCheck);
515 WriteNode memoryWrite = graph.add(new WriteNode(address, NamedLocationIdentity.getArrayLocation(elementKind), implicitStoreConvert(graph, elementKind, value),
516 arrayStoreBarrierType(storeIndexed.elementKind())));
517 memoryWrite.setGuard(boundsCheck);
518 if (condition != null) {
519 tool.createGuard(storeIndexed, condition, DeoptimizationReason.ArrayStoreException, DeoptimizationAction.InvalidateReprofile);
520 }
521 memoryWrite.setStateAfter(storeIndexed.stateAfter());
522 graph.replaceFixedWithFixed(storeIndexed, memoryWrite);
523 }
524
525 protected void lowerArrayLengthNode(ArrayLengthNode arrayLengthNode, LoweringTool tool) {
526 arrayLengthNode.replaceAtUsages(createReadArrayLength(arrayLengthNode.array(), arrayLengthNode, tool));
527 StructuredGraph graph = arrayLengthNode.graph();
528 graph.removeFixed(arrayLengthNode);
529 }
530
531 /**
532 * Creates a read node that read the array length and is guarded by a null-check.
533 *
534 * The created node is placed before {@code before} in the CFG.
535 */
536 protected ReadNode createReadArrayLength(ValueNode array, FixedNode before, LoweringTool tool) {
537 StructuredGraph graph = array.graph();
538 ValueNode canonicalArray = this.createNullCheckedValue(skipPiWhileNonNull(array), before, tool);
539 AddressNode address = createOffsetAddress(graph, canonicalArray, arrayLengthOffset());
540 ReadNode readArrayLength = graph.add(new ReadNode(address, ARRAY_LENGTH_LOCATION, StampFactory.positiveInt(), BarrierType.NONE));
541 graph.addBeforeFixed(before, readArrayLength);
542 return readArrayLength;
543 }
544
545 protected void lowerLoadHubNode(LoadHubNode loadHub, LoweringTool tool) {
546 StructuredGraph graph = loadHub.graph();
547 if (tool.getLoweringStage() != LoweringTool.StandardLoweringStage.LOW_TIER) {
548 return;
549 }
550 if (graph.getGuardsStage().allowsFloatingGuards()) {
551 return;
552 }
553 ValueNode hub = createReadHub(graph, loadHub.getValue(), tool);
554 loadHub.replaceAtUsagesAndDelete(hub);
555 }
556
557 protected void lowerLoadArrayComponentHubNode(LoadArrayComponentHubNode loadHub) {
558 StructuredGraph graph = loadHub.graph();
559 ValueNode hub = createReadArrayComponentHub(graph, loadHub.getValue(), loadHub);
560 graph.replaceFixed(loadHub, hub);
561 }
562
563 protected void lowerMonitorEnterNode(MonitorEnterNode monitorEnter, LoweringTool tool, StructuredGraph graph) {
564 ValueNode object = createNullCheckedValue(monitorEnter.object(), monitorEnter, tool);
565 ValueNode hub = graph.addOrUnique(LoadHubNode.create(object, tool.getStampProvider(), tool.getMetaAccess(), tool.getConstantReflection()));
566 RawMonitorEnterNode rawMonitorEnter = graph.add(new RawMonitorEnterNode(object, hub, monitorEnter.getMonitorId()));
567 rawMonitorEnter.setStateBefore(monitorEnter.stateBefore());
568 rawMonitorEnter.setStateAfter(monitorEnter.stateAfter());
569 graph.replaceFixedWithFixed(monitorEnter, rawMonitorEnter);
570 }
571
572 protected void lowerCompareAndSwapNode(UnsafeCompareAndSwapNode cas) {
573 StructuredGraph graph = cas.graph();
574 JavaKind valueKind = cas.getValueKind();
575
576 ValueNode expectedValue = implicitStoreConvert(graph, valueKind, cas.expected());
577 ValueNode newValue = implicitStoreConvert(graph, valueKind, cas.newValue());
578
579 AddressNode address = graph.unique(new OffsetAddressNode(cas.object(), cas.offset()));
580 BarrierType barrierType = guessStoreBarrierType(cas.object(), expectedValue);
581 LogicCompareAndSwapNode atomicNode = graph.add(new LogicCompareAndSwapNode(address, cas.getLocationIdentity(), expectedValue, newValue, barrierType));
582 atomicNode.setStateAfter(cas.stateAfter());
583 graph.replaceFixedWithFixed(cas, atomicNode);
584 }
585
586 protected void lowerCompareAndExchangeNode(UnsafeCompareAndExchangeNode cas) {
587 StructuredGraph graph = cas.graph();
588 JavaKind valueKind = cas.getValueKind();
589
590 ValueNode expectedValue = implicitStoreConvert(graph, valueKind, cas.expected());
591 ValueNode newValue = implicitStoreConvert(graph, valueKind, cas.newValue());
592
593 AddressNode address = graph.unique(new OffsetAddressNode(cas.object(), cas.offset()));
594 BarrierType barrierType = guessStoreBarrierType(cas.object(), expectedValue);
595 ValueCompareAndSwapNode atomicNode = graph.add(new ValueCompareAndSwapNode(address, expectedValue, newValue, cas.getLocationIdentity(), barrierType));
596 ValueNode coercedNode = implicitLoadConvert(graph, valueKind, atomicNode, true);
597 atomicNode.setStateAfter(cas.stateAfter());
598 cas.replaceAtUsages(coercedNode);
599 graph.replaceFixedWithFixed(cas, atomicNode);
600 }
601
602 protected void lowerAtomicReadAndWriteNode(AtomicReadAndWriteNode n) {
603 StructuredGraph graph = n.graph();
604 JavaKind valueKind = n.getValueKind();
605
606 ValueNode newValue = implicitStoreConvert(graph, valueKind, n.newValue());
607
608 AddressNode address = graph.unique(new OffsetAddressNode(n.object(), n.offset()));
609 BarrierType barrierType = guessStoreBarrierType(n.object(), n.newValue());
610 LIRKind lirAccessKind = LIRKind.fromJavaKind(target.arch, valueKind);
611 LoweredAtomicReadAndWriteNode memoryRead = graph.add(new LoweredAtomicReadAndWriteNode(address, n.getLocationIdentity(), newValue, lirAccessKind, barrierType));
612 memoryRead.setStateAfter(n.stateAfter());
613
614 ValueNode readValue = implicitLoadConvert(graph, valueKind, memoryRead);
615 n.stateAfter().replaceFirstInput(n, memoryRead);
616 n.replaceAtUsages(readValue);
617 graph.replaceFixedWithFixed(n, memoryRead);
618 }
619
620 /**
621 * @param tool utility for performing the lowering
622 */
623 protected void lowerUnsafeLoadNode(RawLoadNode load, LoweringTool tool) {
624 StructuredGraph graph = load.graph();
625 if (load instanceof GuardedUnsafeLoadNode) {
626 GuardedUnsafeLoadNode guardedLoad = (GuardedUnsafeLoadNode) load;
627 GuardingNode guard = guardedLoad.getGuard();
628 if (guard == null) {
629 // can float freely if the guard folded away
630 ReadNode memoryRead = createUnsafeRead(graph, load, null);
631 memoryRead.setForceFixed(false);
632 graph.replaceFixedWithFixed(load, memoryRead);
633 } else {
634 // must be guarded, but flows below the guard
635 ReadNode memoryRead = createUnsafeRead(graph, load, guard);
636 graph.replaceFixedWithFixed(load, memoryRead);
637 }
638 } else {
639 // never had a guarding condition so it must be fixed, creation of the read will force
640 // it to be fixed
641 ReadNode memoryRead = createUnsafeRead(graph, load, null);
642 graph.replaceFixedWithFixed(load, memoryRead);
643 }
644 }
645
646 protected AddressNode createUnsafeAddress(StructuredGraph graph, ValueNode object, ValueNode offset) {
647 if (object.isConstant() && object.asConstant().isDefaultForKind()) {
648 return graph.addOrUniqueWithInputs(OffsetAddressNode.create(offset));
649 } else {
650 return graph.unique(new OffsetAddressNode(object, offset));
651 }
652 }
653
654 protected ReadNode createUnsafeRead(StructuredGraph graph, RawLoadNode load, GuardingNode guard) {
655 boolean compressible = load.accessKind() == JavaKind.Object;
656 JavaKind readKind = load.accessKind();
657 Stamp loadStamp = loadStamp(load.stamp(NodeView.DEFAULT), readKind, compressible);
658 AddressNode address = createUnsafeAddress(graph, load.object(), load.offset());
659 ReadNode memoryRead = graph.add(new ReadNode(address, load.getLocationIdentity(), loadStamp, BarrierType.NONE));
660 if (guard == null) {
661 // An unsafe read must not float otherwise it may float above
662 // a test guaranteeing the read is safe.
663 memoryRead.setForceFixed(true);
664 } else {
665 memoryRead.setGuard(guard);
666 }
667 ValueNode readValue = performBooleanCoercionIfNecessary(implicitLoadConvert(graph, readKind, memoryRead, compressible), readKind);
668 load.replaceAtUsages(readValue);
669 return memoryRead;
670 }
671
672 protected void lowerUnsafeMemoryLoadNode(UnsafeMemoryLoadNode load) {
673 StructuredGraph graph = load.graph();
674 JavaKind readKind = load.getKind();
675 assert readKind != JavaKind.Object;
676 Stamp loadStamp = loadStamp(load.stamp(NodeView.DEFAULT), readKind, false);
677 AddressNode address = graph.addOrUniqueWithInputs(OffsetAddressNode.create(load.getAddress()));
678 ReadNode memoryRead = graph.add(new ReadNode(address, load.getLocationIdentity(), loadStamp, BarrierType.NONE));
679 // An unsafe read must not float otherwise it may float above
680 // a test guaranteeing the read is safe.
681 memoryRead.setForceFixed(true);
682 ValueNode readValue = performBooleanCoercionIfNecessary(implicitLoadConvert(graph, readKind, memoryRead, false), readKind);
683 load.replaceAtUsages(readValue);
684 graph.replaceFixedWithFixed(load, memoryRead);
685 }
686
687 private static ValueNode performBooleanCoercionIfNecessary(ValueNode readValue, JavaKind readKind) {
688 if (readKind == JavaKind.Boolean) {
689 StructuredGraph graph = readValue.graph();
690 IntegerEqualsNode eq = graph.addOrUnique(new IntegerEqualsNode(readValue, ConstantNode.forInt(0, graph)));
691 return graph.addOrUnique(new ConditionalNode(eq, ConstantNode.forBoolean(false, graph), ConstantNode.forBoolean(true, graph)));
692 }
693 return readValue;
694 }
695
696 protected void lowerUnsafeStoreNode(RawStoreNode store) {
697 StructuredGraph graph = store.graph();
698 boolean compressible = store.value().getStackKind() == JavaKind.Object;
699 JavaKind valueKind = store.accessKind();
700 ValueNode value = implicitStoreConvert(graph, valueKind, store.value(), compressible);
701 AddressNode address = createUnsafeAddress(graph, store.object(), store.offset());
702 WriteNode write = graph.add(new WriteNode(address, store.getLocationIdentity(), value, unsafeStoreBarrierType(store)));
703 write.setStateAfter(store.stateAfter());
704 graph.replaceFixedWithFixed(store, write);
705 }
706
707 protected void lowerUnsafeMemoryStoreNode(UnsafeMemoryStoreNode store) {
708 StructuredGraph graph = store.graph();
709 assert store.getValue().getStackKind() != JavaKind.Object;
710 JavaKind valueKind = store.getKind();
711 ValueNode value = implicitStoreConvert(graph, valueKind, store.getValue(), false);
712 AddressNode address = graph.addOrUniqueWithInputs(OffsetAddressNode.create(store.getAddress()));
713 WriteNode write = graph.add(new WriteNode(address, store.getLocationIdentity(), value, BarrierType.NONE));
714 write.setStateAfter(store.stateAfter());
715 graph.replaceFixedWithFixed(store, write);
716 }
717
718 protected void lowerJavaReadNode(JavaReadNode read) {
719 StructuredGraph graph = read.graph();
720 JavaKind valueKind = read.getReadKind();
721 Stamp loadStamp = loadStamp(read.stamp(NodeView.DEFAULT), valueKind, read.isCompressible());
722
723 ReadNode memoryRead = graph.add(new ReadNode(read.getAddress(), read.getLocationIdentity(), loadStamp, read.getBarrierType()));
724 GuardingNode guard = read.getGuard();
725 ValueNode readValue = implicitLoadConvert(graph, valueKind, memoryRead, read.isCompressible());
726 if (guard == null) {
727 // An unsafe read must not float otherwise it may float above
728 // a test guaranteeing the read is safe.
729 memoryRead.setForceFixed(true);
730 } else {
731 memoryRead.setGuard(guard);
732 }
733 read.replaceAtUsages(readValue);
734 graph.replaceFixed(read, memoryRead);
735 }
736
737 protected void lowerJavaWriteNode(JavaWriteNode write) {
738 StructuredGraph graph = write.graph();
739 ValueNode value = implicitStoreConvert(graph, write.getWriteKind(), write.value(), write.isCompressible());
740 WriteNode memoryWrite = graph.add(new WriteNode(write.getAddress(), write.getLocationIdentity(), value, write.getBarrierType()));
741 memoryWrite.setStateAfter(write.stateAfter());
742 graph.replaceFixedWithFixed(write, memoryWrite);
743 memoryWrite.setGuard(write.getGuard());
744 }
745
746 @SuppressWarnings("try")
747 protected void lowerCommitAllocationNode(CommitAllocationNode commit, LoweringTool tool) {
748 StructuredGraph graph = commit.graph();
749 if (graph.getGuardsStage() == StructuredGraph.GuardsStage.FIXED_DEOPTS) {
750 List<AbstractNewObjectNode> recursiveLowerings = new ArrayList<>();
751
752 ValueNode[] allocations = new ValueNode[commit.getVirtualObjects().size()];
753 BitSet omittedValues = new BitSet();
754 int valuePos = 0;
755 for (int objIndex = 0; objIndex < commit.getVirtualObjects().size(); objIndex++) {
756 VirtualObjectNode virtual = commit.getVirtualObjects().get(objIndex);
757 try (DebugCloseable nsp = graph.withNodeSourcePosition(virtual)) {
758 int entryCount = virtual.entryCount();
759 AbstractNewObjectNode newObject;
760 if (virtual instanceof VirtualInstanceNode) {
761 newObject = graph.add(createNewInstanceFromVirtual(virtual));
762 } else {
763 newObject = graph.add(createNewArrayFromVirtual(virtual, ConstantNode.forInt(entryCount, graph)));
764 }
765
766 recursiveLowerings.add(newObject);
767 graph.addBeforeFixed(commit, newObject);
768 allocations[objIndex] = newObject;
769 for (int i = 0; i < entryCount; i++) {
770 ValueNode value = commit.getValues().get(valuePos);
771 if (value instanceof VirtualObjectNode) {
772 value = allocations[commit.getVirtualObjects().indexOf(value)];
773 }
774 if (value == null) {
775 omittedValues.set(valuePos);
776 } else if (!(value.isConstant() && value.asConstant().isDefaultForKind())) {
777 // Constant.illegal is always the defaultForKind, so it is skipped
778 JavaKind valueKind = value.getStackKind();
779 JavaKind entryKind = virtual.entryKind(i);
780
781 // Truffle requires some leniency in terms of what can be put where:
782 assert valueKind.getStackKind() == entryKind.getStackKind() ||
783 (valueKind == JavaKind.Long || valueKind == JavaKind.Double || (valueKind == JavaKind.Int && virtual instanceof VirtualArrayNode));
784 AddressNode address = null;
785 BarrierType barrierType = null;
786 if (virtual instanceof VirtualInstanceNode) {
787 ResolvedJavaField field = ((VirtualInstanceNode) virtual).field(i);
788 long offset = fieldOffset(field);
789 if (offset >= 0) {
790 address = createOffsetAddress(graph, newObject, offset);
791 barrierType = fieldInitializationBarrier(entryKind);
792 }
793 } else {
794 address = createOffsetAddress(graph, newObject, metaAccess.getArrayBaseOffset(entryKind) + i * metaAccess.getArrayIndexScale(entryKind));
795 barrierType = arrayInitializationBarrier(entryKind);
796 }
797 if (address != null) {
798 WriteNode write = new WriteNode(address, LocationIdentity.init(), implicitStoreConvert(graph, entryKind, value), barrierType);
799 graph.addAfterFixed(newObject, graph.add(write));
800 }
801 }
802 valuePos++;
803 }
804 }
805 }
806 valuePos = 0;
807
808 for (int objIndex = 0; objIndex < commit.getVirtualObjects().size(); objIndex++) {
809 VirtualObjectNode virtual = commit.getVirtualObjects().get(objIndex);
810 try (DebugCloseable nsp = graph.withNodeSourcePosition(virtual)) {
811 int entryCount = virtual.entryCount();
812 ValueNode newObject = allocations[objIndex];
813 for (int i = 0; i < entryCount; i++) {
814 if (omittedValues.get(valuePos)) {
815 ValueNode value = commit.getValues().get(valuePos);
816 assert value instanceof VirtualObjectNode;
817 ValueNode allocValue = allocations[commit.getVirtualObjects().indexOf(value)];
818 if (!(allocValue.isConstant() && allocValue.asConstant().isDefaultForKind())) {
819 assert virtual.entryKind(i) == JavaKind.Object && allocValue.getStackKind() == JavaKind.Object;
820 AddressNode address;
821 BarrierType barrierType;
822 if (virtual instanceof VirtualInstanceNode) {
823 VirtualInstanceNode virtualInstance = (VirtualInstanceNode) virtual;
824 address = createFieldAddress(graph, newObject, virtualInstance.field(i));
825 barrierType = BarrierType.IMPRECISE;
826 } else {
827 address = createArrayAddress(graph, newObject, virtual.entryKind(i), ConstantNode.forInt(i, graph));
828 barrierType = BarrierType.PRECISE;
829 }
830 if (address != null) {
831 WriteNode write = new WriteNode(address, LocationIdentity.init(), implicitStoreConvert(graph, JavaKind.Object, allocValue), barrierType);
832 graph.addBeforeFixed(commit, graph.add(write));
833 }
834 }
835 }
836 valuePos++;
837 }
838 }
839 }
840
841 finishAllocatedObjects(tool, commit, allocations);
842 graph.removeFixed(commit);
843
844 for (AbstractNewObjectNode recursiveLowering : recursiveLowerings) {
845 recursiveLowering.lower(tool);
846 }
847 }
848
849 }
850
851 public NewInstanceNode createNewInstanceFromVirtual(VirtualObjectNode virtual) {
852 return new NewInstanceNode(virtual.type(), true);
853 }
854
855 protected NewArrayNode createNewArrayFromVirtual(VirtualObjectNode virtual, ValueNode length) {
856 return new NewArrayNode(((VirtualArrayNode) virtual).componentType(), length, true);
857 }
858
859 public void finishAllocatedObjects(LoweringTool tool, CommitAllocationNode commit, ValueNode[] allocations) {
860 StructuredGraph graph = commit.graph();
861 for (int objIndex = 0; objIndex < commit.getVirtualObjects().size(); objIndex++) {
862 FixedValueAnchorNode anchor = graph.add(new FixedValueAnchorNode(allocations[objIndex]));
863 allocations[objIndex] = anchor;
864 graph.addBeforeFixed(commit, anchor);
865 }
866 /*
867 * Note that the FrameState that is assigned to these MonitorEnterNodes isn't the correct
868 * state. It will be the state from before the allocation occurred instead of a valid state
869 * after the locking is performed. In practice this should be fine since these are newly
870 * allocated objects. The bytecodes themselves permit allocating an object, doing a
871 * monitorenter and then dropping all references to the object which would produce the same
872 * state, though that would normally produce an IllegalMonitorStateException. In HotSpot
873 * some form of fast path locking should always occur so the FrameState should never
874 * actually be used.
875 */
876 ArrayList<MonitorEnterNode> enters = null;
877 for (int objIndex = 0; objIndex < commit.getVirtualObjects().size(); objIndex++) {
878 List<MonitorIdNode> locks = commit.getLocks(objIndex);
879 if (locks.size() > 1) {
880 // Ensure that the lock operations are performed in lock depth order
881 ArrayList<MonitorIdNode> newList = new ArrayList<>(locks);
882 newList.sort((a, b) -> Integer.compare(a.getLockDepth(), b.getLockDepth()));
883 locks = newList;
884 }
885 int lastDepth = -1;
886 for (MonitorIdNode monitorId : locks) {
887 assert lastDepth < monitorId.getLockDepth();
888 lastDepth = monitorId.getLockDepth();
889 MonitorEnterNode enter = graph.add(new MonitorEnterNode(allocations[objIndex], monitorId));
890 graph.addBeforeFixed(commit, enter);
891 if (enters == null) {
892 enters = new ArrayList<>();
893 }
894 enters.add(enter);
895 }
896 }
897 for (Node usage : commit.usages().snapshot()) {
898 if (usage instanceof AllocatedObjectNode) {
899 AllocatedObjectNode addObject = (AllocatedObjectNode) usage;
900 int index = commit.getVirtualObjects().indexOf(addObject.getVirtualObject());
901 addObject.replaceAtUsagesAndDelete(allocations[index]);
902 } else {
903 assert enters != null;
904 commit.replaceAtUsages(InputType.Memory, enters.get(enters.size() - 1));
905 }
906 }
907 if (enters != null) {
908 for (MonitorEnterNode enter : enters) {
909 enter.lower(tool);
910 }
911 }
912 assert commit.hasNoUsages();
913 insertAllocationBarrier(commit, graph);
914 }
915
916 /**
917 * Insert the required {@link MemoryBarriers#STORE_STORE} barrier for an allocation and also
918 * include the {@link MemoryBarriers#LOAD_STORE} required for final fields if any final fields
919 * are being written, as if {@link FinalFieldBarrierNode} were emitted.
920 */
921 private static void insertAllocationBarrier(CommitAllocationNode commit, StructuredGraph graph) {
922 int barrier = MemoryBarriers.STORE_STORE;
923 outer: for (VirtualObjectNode vobj : commit.getVirtualObjects()) {
924 for (ResolvedJavaField field : vobj.type().getInstanceFields(true)) {
925 if (field.isFinal()) {
926 barrier = barrier | MemoryBarriers.LOAD_STORE;
927 break outer;
928 }
929 }
930 }
931 graph.addAfterFixed(commit, graph.add(new MembarNode(barrier, LocationIdentity.init())));
932 }
933
934 /**
935 * @param field the field whose barrier type should be returned
936 */
937 protected BarrierType fieldLoadBarrierType(ResolvedJavaField field) {
938 return BarrierType.NONE;
939 }
940
941 protected BarrierType fieldStoreBarrierType(ResolvedJavaField field) {
942 if (field.getJavaKind() == JavaKind.Object) {
943 return BarrierType.IMPRECISE;
944 }
945 return BarrierType.NONE;
946 }
947
948 protected BarrierType arrayStoreBarrierType(JavaKind elementKind) {
949 if (elementKind == JavaKind.Object) {
950 return BarrierType.PRECISE;
951 }
952 return BarrierType.NONE;
953 }
954
955 public BarrierType fieldInitializationBarrier(JavaKind entryKind) {
956 return entryKind == JavaKind.Object ? BarrierType.IMPRECISE : BarrierType.NONE;
957 }
958
959 public BarrierType arrayInitializationBarrier(JavaKind entryKind) {
960 return entryKind == JavaKind.Object ? BarrierType.PRECISE : BarrierType.NONE;
961 }
962
963 private BarrierType unsafeStoreBarrierType(RawStoreNode store) {
964 if (!store.needsBarrier()) {
965 return BarrierType.NONE;
966 }
967 return guessStoreBarrierType(store.object(), store.value());
968 }
969
970 private BarrierType guessStoreBarrierType(ValueNode object, ValueNode value) {
971 if (value.getStackKind() == JavaKind.Object && object.getStackKind() == JavaKind.Object) {
972 ResolvedJavaType type = StampTool.typeOrNull(object);
973 // Array types must use a precise barrier, so if the type is unknown or is a supertype
974 // of Object[] then treat it as an array.
975 if (type == null || type.isArray() || type.isAssignableFrom(objectArrayType)) {
976 return BarrierType.PRECISE;
977 } else {
978 return BarrierType.IMPRECISE;
979 }
980 }
981 return BarrierType.NONE;
982 }
983
984 public abstract int fieldOffset(ResolvedJavaField field);
985
986 public FieldLocationIdentity fieldLocationIdentity(ResolvedJavaField field) {
987 return new FieldLocationIdentity(field);
988 }
989
990 public abstract ValueNode staticFieldBase(StructuredGraph graph, ResolvedJavaField field);
991
992 public abstract int arrayLengthOffset();
993
994 public Stamp loadStamp(Stamp stamp, JavaKind kind) {
995 return loadStamp(stamp, kind, true);
996 }
997
998 private boolean useCompressedOops(JavaKind kind, boolean compressible) {
999 return kind == JavaKind.Object && compressible && useCompressedOops;
1000 }
1001
1002 protected abstract Stamp loadCompressedStamp(ObjectStamp stamp);
1003
1004 /**
1005 * @param compressible whether the stamp should be compressible
1006 */
1007 protected Stamp loadStamp(Stamp stamp, JavaKind kind, boolean compressible) {
1008 if (useCompressedOops(kind, compressible)) {
1009 return loadCompressedStamp((ObjectStamp) stamp);
1010 }
1011
1012 switch (kind) {
1013 case Boolean:
1014 case Byte:
1015 return IntegerStamp.OPS.getNarrow().foldStamp(32, 8, stamp);
1016 case Char:
1017 case Short:
1018 return IntegerStamp.OPS.getNarrow().foldStamp(32, 16, stamp);
1019 }
1020 return stamp;
1021 }
1022
1023 public final ValueNode implicitLoadConvert(StructuredGraph graph, JavaKind kind, ValueNode value) {
1024 return implicitLoadConvert(graph, kind, value, true);
1025 }
1026
1027 public ValueNode implicitLoadConvert(JavaKind kind, ValueNode value) {
1028 return implicitLoadConvert(kind, value, true);
1029 }
1030
1031 protected final ValueNode implicitLoadConvert(StructuredGraph graph, JavaKind kind, ValueNode value, boolean compressible) {
1032 ValueNode ret = implicitLoadConvert(kind, value, compressible);
1033 if (!ret.isAlive()) {
1034 ret = graph.addOrUnique(ret);
1035 }
1036 return ret;
1037 }
1038
1039 protected abstract ValueNode newCompressionNode(CompressionOp op, ValueNode value);
1040
1041 /**
1042 * @param compressible whether the convert should be compressible
1043 */
1044 protected ValueNode implicitLoadConvert(JavaKind kind, ValueNode value, boolean compressible) {
1045 if (useCompressedOops(kind, compressible)) {
1046 return newCompressionNode(CompressionOp.Uncompress, value);
1047 }
1048
1049 switch (kind) {
1050 case Byte:
1051 case Short:
1052 return new SignExtendNode(value, 32);
1053 case Boolean:
1054 case Char:
1055 return new ZeroExtendNode(value, 32);
1056 }
1057 return value;
1058 }
1059
1060 public final ValueNode implicitStoreConvert(StructuredGraph graph, JavaKind kind, ValueNode value) {
1061 return implicitStoreConvert(graph, kind, value, true);
1062 }
1063
1064 public ValueNode implicitStoreConvert(JavaKind kind, ValueNode value) {
1065 return implicitStoreConvert(kind, value, true);
1066 }
1067
1068 protected final ValueNode implicitStoreConvert(StructuredGraph graph, JavaKind kind, ValueNode value, boolean compressible) {
1069 ValueNode ret = implicitStoreConvert(kind, value, compressible);
1070 if (!ret.isAlive()) {
1071 ret = graph.addOrUnique(ret);
1072 }
1073 return ret;
1074 }
1075
1076 /**
1077 * @param compressible whether the covert should be compressible
1078 */
1079 protected ValueNode implicitStoreConvert(JavaKind kind, ValueNode value, boolean compressible) {
1080 if (useCompressedOops(kind, compressible)) {
1081 return newCompressionNode(CompressionOp.Compress, value);
1082 }
1083
1084 switch (kind) {
1085 case Boolean:
1086 case Byte:
1087 return new NarrowNode(value, 8);
1088 case Char:
1089 case Short:
1090 return new NarrowNode(value, 16);
1091 }
1092 return value;
1093 }
1094
1095 protected abstract ValueNode createReadHub(StructuredGraph graph, ValueNode object, LoweringTool tool);
1096
1097 protected abstract ValueNode createReadArrayComponentHub(StructuredGraph graph, ValueNode arrayHub, FixedNode anchor);
1098
1099 protected ValueNode proxyIndex(AccessIndexedNode n, ValueNode index, ValueNode array, LoweringTool tool) {
1100 StructuredGraph graph = index.graph();
1101 ValueNode arrayLength = readOrCreateArrayLength(n, array, tool, graph);
1102 ValueNode lengthMinusOne = SubNode.create(arrayLength, ConstantNode.forInt(1), NodeView.DEFAULT);
1103 return branchlessMax(branchlessMin(index, lengthMinusOne, NodeView.DEFAULT), ConstantNode.forInt(0), NodeView.DEFAULT);
1104 }
1105
1106 protected GuardingNode getBoundsCheck(AccessIndexedNode n, ValueNode array, LoweringTool tool) {
1107 if (n.getBoundsCheck() != null) {
1108 return n.getBoundsCheck();
1109 }
1110
1111 StructuredGraph graph = n.graph();
1112 ValueNode arrayLength = readOrCreateArrayLength(n, array, tool, graph);
1113
1114 LogicNode boundsCheck = IntegerBelowNode.create(n.index(), arrayLength, NodeView.DEFAULT);
1115 if (boundsCheck.isTautology()) {
1116 return null;
1117 }
1118 return tool.createGuard(n, graph.addOrUniqueWithInputs(boundsCheck), BoundsCheckException, InvalidateReprofile);
1119 }
1120
1121 private ValueNode readOrCreateArrayLength(AccessIndexedNode n, ValueNode array, LoweringTool tool, StructuredGraph graph) {
1122 ValueNode arrayLength = readArrayLength(array, tool.getConstantReflection());
1123 if (arrayLength == null) {
1124 arrayLength = createReadArrayLength(array, n, tool);
1125 } else {
1126 arrayLength = arrayLength.isAlive() ? arrayLength : graph.addOrUniqueWithInputs(arrayLength);
1127 }
1128 return arrayLength;
1129 }
1130
1131 protected GuardingNode createNullCheck(ValueNode object, FixedNode before, LoweringTool tool) {
1132 if (StampTool.isPointerNonNull(object)) {
1133 return null;
1134 }
1135 return tool.createGuard(before, before.graph().unique(IsNullNode.create(object)), NullCheckException, InvalidateReprofile, SpeculationLog.NO_SPECULATION, true, null);
1136 }
1137
1138 protected ValueNode createNullCheckedValue(ValueNode object, FixedNode before, LoweringTool tool) {
1139 GuardingNode nullCheck = createNullCheck(object, before, tool);
1140 if (nullCheck == null) {
1141 return object;
1142 }
1143 return before.graph().maybeAddOrUnique(PiNode.create(object, (object.stamp(NodeView.DEFAULT)).join(StampFactory.objectNonNull()), (ValueNode) nullCheck));
1144 }
1145
1146 @Override
1147 public ValueNode reconstructArrayIndex(JavaKind elementKind, AddressNode address) {
1148 StructuredGraph graph = address.graph();
1149 ValueNode offset = ((OffsetAddressNode) address).getOffset();
1150
1151 int base = metaAccess.getArrayBaseOffset(elementKind);
1152 ValueNode scaledIndex = graph.unique(new SubNode(offset, ConstantNode.forIntegerStamp(offset.stamp(NodeView.DEFAULT), base, graph)));
1153
1154 int shift = CodeUtil.log2(metaAccess.getArrayIndexScale(elementKind));
1155 ValueNode ret = graph.unique(new RightShiftNode(scaledIndex, ConstantNode.forInt(shift, graph)));
1156 return IntegerConvertNode.convert(ret, StampFactory.forKind(JavaKind.Int), graph, NodeView.DEFAULT);
1157 }
1158 }