1 /* 2 * Copyright (c) 2013, 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.nodes; 26 27 import static org.graalvm.compiler.nodeinfo.InputType.Memory; 28 import static org.graalvm.compiler.nodeinfo.InputType.State; 29 import static org.graalvm.compiler.nodeinfo.NodeSize.SIZE_64; 30 import static jdk.internal.vm.compiler.word.LocationIdentity.any; 31 32 import org.graalvm.compiler.core.common.type.StampFactory; 33 import org.graalvm.compiler.debug.DebugContext; 34 import org.graalvm.compiler.graph.NodeClass; 35 import org.graalvm.compiler.graph.NodeInputList; 36 import org.graalvm.compiler.nodeinfo.NodeCycles; 37 import org.graalvm.compiler.nodeinfo.NodeInfo; 38 import org.graalvm.compiler.nodes.ConstantNode; 39 import org.graalvm.compiler.nodes.DeoptimizingNode; 40 import org.graalvm.compiler.nodes.FrameState; 41 import org.graalvm.compiler.nodes.NamedLocationIdentity; 42 import org.graalvm.compiler.nodes.NodeView; 43 import org.graalvm.compiler.nodes.ValueNode; 44 import org.graalvm.compiler.nodes.java.LoadIndexedNode; 45 import org.graalvm.compiler.nodes.memory.AbstractMemoryCheckpoint; 46 import org.graalvm.compiler.nodes.memory.MemoryAccess; 47 import org.graalvm.compiler.nodes.memory.MemoryCheckpoint; 48 import org.graalvm.compiler.nodes.memory.MemoryNode; 49 import org.graalvm.compiler.nodes.spi.Lowerable; 50 import org.graalvm.compiler.nodes.spi.LoweringTool; 51 import org.graalvm.compiler.nodes.spi.Virtualizable; 52 import org.graalvm.compiler.nodes.spi.VirtualizerTool; 53 import org.graalvm.compiler.nodes.type.StampTool; 54 import org.graalvm.compiler.nodes.virtual.VirtualArrayNode; 55 import org.graalvm.compiler.nodes.virtual.VirtualObjectNode; 56 import jdk.internal.vm.compiler.word.LocationIdentity; 57 58 import jdk.vm.ci.code.BytecodeFrame; 59 import jdk.vm.ci.meta.JavaKind; 60 import jdk.vm.ci.meta.ResolvedJavaType; 61 62 @NodeInfo(cycles = NodeCycles.CYCLES_UNKNOWN, size = SIZE_64) 63 public class BasicArrayCopyNode extends AbstractMemoryCheckpoint implements Virtualizable, MemoryCheckpoint.Single, MemoryAccess, Lowerable, DeoptimizingNode.DeoptDuring { 64 65 public static final NodeClass<BasicArrayCopyNode> TYPE = NodeClass.create(BasicArrayCopyNode.class); 66 67 static final int SRC_ARG = 0; 68 static final int SRC_POS_ARG = 1; 69 static final int DEST_ARG = 2; 70 static final int DEST_POS_ARG = 3; 71 static final int LENGTH_ARG = 4; 72 73 @Input NodeInputList<ValueNode> args; 74 75 @OptionalInput(State) FrameState stateDuring; 76 77 @OptionalInput(Memory) protected MemoryNode lastLocationAccess; 78 79 protected JavaKind elementKind; 80 81 protected int bci; 82 83 public BasicArrayCopyNode(NodeClass<? extends AbstractMemoryCheckpoint> type, ValueNode src, ValueNode srcPos, ValueNode dest, ValueNode destPos, ValueNode length, JavaKind elementKind, int bci) { 84 super(type, StampFactory.forKind(JavaKind.Void)); 85 this.bci = bci; 86 this.args = new NodeInputList<>(this, new ValueNode[]{src, srcPos, dest, destPos, length}); 87 this.elementKind = elementKind != JavaKind.Illegal ? elementKind : null; 88 } 89 90 public BasicArrayCopyNode(NodeClass<? extends AbstractMemoryCheckpoint> type, ValueNode src, ValueNode srcPos, ValueNode dest, ValueNode destPos, ValueNode length, JavaKind elementKind) { 91 this(type, src, srcPos, dest, destPos, length, elementKind, BytecodeFrame.INVALID_FRAMESTATE_BCI); 92 } 93 94 public ValueNode getSource() { 95 return args.get(SRC_ARG); 96 } 97 98 public ValueNode getSourcePosition() { 99 return args.get(SRC_POS_ARG); 100 } 101 102 public ValueNode getDestination() { 103 return args.get(DEST_ARG); 104 } 105 106 public ValueNode getDestinationPosition() { 107 return args.get(DEST_POS_ARG); 108 } 109 110 public ValueNode getLength() { 111 return args.get(LENGTH_ARG); 112 } 113 114 public int getBci() { 115 return bci; 116 } 117 118 public JavaKind getElementKind() { 119 return elementKind; 120 } 121 122 @Override 123 public LocationIdentity getLocationIdentity() { 124 if (elementKind != null) { 125 return NamedLocationIdentity.getArrayLocation(elementKind); 126 } 127 return any(); 128 } 129 130 @Override 131 public MemoryNode getLastLocationAccess() { 132 return lastLocationAccess; 133 } 134 135 @Override 136 public void setLastLocationAccess(MemoryNode lla) { 137 updateUsagesInterface(lastLocationAccess, lla); 138 lastLocationAccess = lla; 139 } 140 141 @Override 142 public void lower(LoweringTool tool) { 143 tool.getLowerer().lower(this, tool); 144 } 145 146 private static boolean checkBounds(int position, int length, VirtualObjectNode virtualObject) { 147 return position >= 0 && position + length <= virtualObject.entryCount(); 148 } 149 150 private static boolean checkEntryTypes(int srcPos, int length, VirtualObjectNode src, ResolvedJavaType destComponentType, VirtualizerTool tool) { 151 if (destComponentType.getJavaKind() == JavaKind.Object && !destComponentType.isJavaLangObject()) { 152 for (int i = 0; i < length; i++) { 153 ValueNode entry = tool.getEntry(src, srcPos + i); 154 ResolvedJavaType type = StampTool.typeOrNull(entry); 155 if (type == null || !destComponentType.isAssignableFrom(type)) { 156 return false; 157 } 158 } 159 } 160 return true; 161 } 162 163 /* 164 * Returns true if this copy doesn't require store checks. Trivially true for primitive arrays. 165 */ 166 public boolean isExact() { 167 ResolvedJavaType srcType = StampTool.typeOrNull(getSource().stamp(NodeView.DEFAULT)); 168 ResolvedJavaType destType = StampTool.typeOrNull(getDestination().stamp(NodeView.DEFAULT)); 169 if (srcType == null || !srcType.isArray() || destType == null || !destType.isArray()) { 170 return false; 171 } 172 if ((srcType.getComponentType().getJavaKind().isPrimitive() && destType.getComponentType().equals(srcType.getComponentType())) || getSource() == getDestination()) { 173 return true; 174 } 175 176 if (StampTool.isExactType(getDestination().stamp(NodeView.DEFAULT))) { 177 if (destType != null && destType.isAssignableFrom(srcType)) { 178 return true; 179 } 180 } 181 return false; 182 } 183 184 @Override 185 public void virtualize(VirtualizerTool tool) { 186 ValueNode sourcePosition = tool.getAlias(getSourcePosition()); 187 ValueNode destinationPosition = tool.getAlias(getDestinationPosition()); 188 ValueNode replacedLength = tool.getAlias(getLength()); 189 190 if (sourcePosition.isConstant() && destinationPosition.isConstant() && replacedLength.isConstant()) { 191 int srcPosInt = sourcePosition.asJavaConstant().asInt(); 192 int destPosInt = destinationPosition.asJavaConstant().asInt(); 193 int len = replacedLength.asJavaConstant().asInt(); 194 ValueNode destAlias = tool.getAlias(getDestination()); 195 196 if (destAlias instanceof VirtualArrayNode) { 197 VirtualArrayNode destVirtual = (VirtualArrayNode) destAlias; 198 if (len < 0 || !checkBounds(destPosInt, len, destVirtual)) { 199 return; 200 } 201 ValueNode srcAlias = tool.getAlias(getSource()); 202 203 if (srcAlias instanceof VirtualObjectNode) { 204 if (!(srcAlias instanceof VirtualArrayNode)) { 205 return; 206 } 207 VirtualArrayNode srcVirtual = (VirtualArrayNode) srcAlias; 208 if (destVirtual.componentType().getJavaKind() != srcVirtual.componentType().getJavaKind()) { 209 return; 210 } 211 if (!checkBounds(srcPosInt, len, srcVirtual)) { 212 return; 213 } 214 if (!checkEntryTypes(srcPosInt, len, srcVirtual, destVirtual.type().getComponentType(), tool)) { 215 return; 216 } 217 for (int i = 0; i < len; i++) { 218 tool.setVirtualEntry(destVirtual, destPosInt + i, tool.getEntry(srcVirtual, srcPosInt + i)); 219 } 220 tool.delete(); 221 DebugContext debug = getDebug(); 222 if (debug.isLogEnabled()) { 223 debug.log("virtualized arraycopy(%s, %d, %s, %d, %d)", getSource(), srcPosInt, getDestination(), destPosInt, len); 224 } 225 } else { 226 ResolvedJavaType sourceType = StampTool.typeOrNull(srcAlias); 227 if (sourceType == null || !sourceType.isArray()) { 228 return; 229 } 230 ResolvedJavaType sourceComponentType = sourceType.getComponentType(); 231 ResolvedJavaType destComponentType = destVirtual.type().getComponentType(); 232 if (!sourceComponentType.equals(destComponentType)) { 233 return; 234 } 235 for (int i = 0; i < len; i++) { 236 LoadIndexedNode load = new LoadIndexedNode(graph().getAssumptions(), srcAlias, ConstantNode.forInt(i + srcPosInt, graph()), null, destComponentType.getJavaKind()); 237 load.setNodeSourcePosition(getNodeSourcePosition()); 238 tool.addNode(load); 239 tool.setVirtualEntry(destVirtual, destPosInt + i, load); 240 } 241 tool.delete(); 242 } 243 } 244 } 245 } 246 247 @Override 248 public boolean canDeoptimize() { 249 return true; 250 } 251 252 @Override 253 public FrameState stateDuring() { 254 return stateDuring; 255 } 256 257 @Override 258 public void setStateDuring(FrameState stateDuring) { 259 updateUsages(this.stateDuring, stateDuring); 260 this.stateDuring = stateDuring; 261 } 262 263 @Override 264 public void computeStateDuring(FrameState currentStateAfter) { 265 FrameState newStateDuring = currentStateAfter.duplicateModifiedDuringCall(getBci(), asNode().getStackKind()); 266 setStateDuring(newStateDuring); 267 } 268 }