1 /*
   2  * Copyright (c) 2013, 2016, 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 package org.graalvm.compiler.hotspot.replacements.arraycopy;
  24 
  25 import static org.graalvm.compiler.nodeinfo.NodeCycles.CYCLES_256;
  26 import static org.graalvm.compiler.nodeinfo.NodeSize.SIZE_64;
  27 import static org.graalvm.word.LocationIdentity.any;
  28 
  29 import org.graalvm.compiler.core.common.type.StampFactory;
  30 import org.graalvm.compiler.graph.NodeClass;
  31 import org.graalvm.compiler.nodeinfo.InputType;
  32 import org.graalvm.compiler.nodeinfo.NodeInfo;
  33 import org.graalvm.compiler.nodes.NamedLocationIdentity;
  34 import org.graalvm.compiler.nodes.ValueNode;
  35 import org.graalvm.compiler.nodes.extended.ArrayRangeWriteNode;
  36 import org.graalvm.compiler.nodes.memory.MemoryAccess;
  37 import org.graalvm.compiler.nodes.memory.MemoryCheckpoint;
  38 import org.graalvm.compiler.nodes.memory.MemoryNode;
  39 import org.graalvm.compiler.nodes.spi.Lowerable;
  40 import org.graalvm.compiler.nodes.spi.LoweringTool;
  41 import org.graalvm.compiler.replacements.SnippetTemplate.Arguments;
  42 import org.graalvm.word.LocationIdentity;
  43 
  44 import jdk.vm.ci.meta.JavaKind;
  45 
  46 @NodeInfo(allowedUsageTypes = {InputType.Memory}, cycles = CYCLES_256, size = SIZE_64)
  47 public final class UnsafeArrayCopyNode extends ArrayRangeWriteNode implements Lowerable, MemoryCheckpoint.Single, MemoryAccess {
  48 
  49     public static final NodeClass<UnsafeArrayCopyNode> TYPE = NodeClass.create(UnsafeArrayCopyNode.class);
  50     @Input ValueNode src;
  51     @Input ValueNode srcPos;
  52     @Input ValueNode dest;
  53     @Input ValueNode destPos;
  54     @Input ValueNode length;
  55     @OptionalInput ValueNode layoutHelper;
  56 
  57     @OptionalInput(InputType.Memory) MemoryNode lastLocationAccess;
  58 
  59     protected JavaKind elementKind;
  60 
  61     public UnsafeArrayCopyNode(ValueNode src, ValueNode srcPos, ValueNode dest, ValueNode destPos, ValueNode length, ValueNode layoutHelper, JavaKind elementKind) {
  62         super(TYPE, StampFactory.forVoid());
  63         assert layoutHelper == null || elementKind == null;
  64         this.src = src;
  65         this.srcPos = srcPos;
  66         this.dest = dest;
  67         this.destPos = destPos;
  68         this.length = length;
  69         this.layoutHelper = layoutHelper;
  70         this.elementKind = elementKind;
  71     }
  72 
  73     public UnsafeArrayCopyNode(ValueNode src, ValueNode srcPos, ValueNode dest, ValueNode destPos, ValueNode length, JavaKind elementKind) {
  74         this(src, srcPos, dest, destPos, length, null, elementKind);
  75     }
  76 
  77     public UnsafeArrayCopyNode(ValueNode src, ValueNode srcPos, ValueNode dest, ValueNode destPos, ValueNode length, ValueNode layoutHelper) {
  78         this(src, srcPos, dest, destPos, length, layoutHelper, null);
  79     }
  80 
  81     @Override
  82     public ValueNode getArray() {
  83         return dest;
  84     }
  85 
  86     @Override
  87     public ValueNode getIndex() {
  88         return destPos;
  89     }
  90 
  91     @Override
  92     public ValueNode getLength() {
  93         return length;
  94     }
  95 
  96     @Override
  97     public boolean isObjectArray() {
  98         return elementKind == JavaKind.Object;
  99     }
 100 
 101     @Override
 102     public boolean isInitialization() {
 103         return false;
 104     }
 105 
 106     public JavaKind getElementKind() {
 107         return elementKind;
 108     }
 109 
 110     @Override
 111     public void lower(LoweringTool tool) {
 112         if (graph().getGuardsStage().areFrameStatesAtDeopts()) {
 113             UnsafeArrayCopySnippets.Templates templates = tool.getReplacements().getSnippetTemplateCache(UnsafeArrayCopySnippets.Templates.class);
 114             templates.lower(this, tool);
 115         }
 116     }
 117 
 118     public void addSnippetArguments(Arguments args) {
 119         args.add("src", src);
 120         args.add("srcPos", srcPos);
 121         args.add("dest", dest);
 122         args.add("destPos", destPos);
 123         args.add("length", length);
 124         if (layoutHelper != null) {
 125             args.add("layoutHelper", layoutHelper);
 126         }
 127     }
 128 
 129     @Override
 130     public LocationIdentity getLocationIdentity() {
 131         if (elementKind != null) {
 132             return NamedLocationIdentity.getArrayLocation(elementKind);
 133         }
 134         return any();
 135     }
 136 
 137     @Override
 138     public MemoryNode getLastLocationAccess() {
 139         return lastLocationAccess;
 140     }
 141 
 142     @Override
 143     public void setLastLocationAccess(MemoryNode lla) {
 144         updateUsagesInterface(lastLocationAccess, lla);
 145         lastLocationAccess = lla;
 146     }
 147 
 148     @NodeIntrinsic
 149     public static native void arraycopy(Object src, int srcPos, Object dest, int destPos, int length, @ConstantNodeParameter JavaKind elementKind);
 150 
 151     @NodeIntrinsic
 152     public static native void arraycopyPrimitive(Object src, int srcPos, Object dest, int destPos, int length, int layoutHelper);
 153 }