1 /*
   2  * Copyright (c) 2011, 2017, 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.nodes.extended;
  26 
  27 import static org.graalvm.compiler.nodeinfo.InputType.State;
  28 import static org.graalvm.compiler.nodeinfo.NodeCycles.CYCLES_2;
  29 import static org.graalvm.compiler.nodeinfo.NodeSize.SIZE_1;
  30 
  31 import org.graalvm.compiler.core.common.type.StampFactory;
  32 import org.graalvm.compiler.graph.NodeClass;
  33 import org.graalvm.compiler.nodeinfo.NodeInfo;
  34 import org.graalvm.compiler.nodes.FrameState;
  35 import org.graalvm.compiler.nodes.StateSplit;
  36 import org.graalvm.compiler.nodes.ValueNode;
  37 import org.graalvm.compiler.nodes.java.StoreFieldNode;
  38 import org.graalvm.compiler.nodes.memory.MemoryCheckpoint;
  39 import org.graalvm.compiler.nodes.spi.Lowerable;
  40 import org.graalvm.compiler.nodes.spi.LoweringTool;
  41 import org.graalvm.compiler.nodes.spi.Virtualizable;
  42 import org.graalvm.compiler.nodes.spi.VirtualizerTool;
  43 import org.graalvm.compiler.nodes.virtual.VirtualObjectNode;
  44 import jdk.internal.vm.compiler.word.LocationIdentity;
  45 
  46 import jdk.vm.ci.meta.Assumptions;
  47 import jdk.vm.ci.meta.JavaKind;
  48 import jdk.vm.ci.meta.ResolvedJavaField;
  49 
  50 /**
  51  * Store of a value at a location specified as an offset relative to an object. No null check is
  52  * performed before the store.
  53  */
  54 @NodeInfo(cycles = CYCLES_2, size = SIZE_1)
  55 public final class RawStoreNode extends UnsafeAccessNode implements StateSplit, Lowerable, Virtualizable, MemoryCheckpoint.Single {
  56 
  57     public static final NodeClass<RawStoreNode> TYPE = NodeClass.create(RawStoreNode.class);
  58     @Input ValueNode value;
  59     @OptionalInput(State) FrameState stateAfter;
  60     private final boolean needsBarrier;
  61 
  62     public RawStoreNode(ValueNode object, ValueNode offset, ValueNode value, JavaKind accessKind, LocationIdentity locationIdentity) {
  63         this(object, offset, value, accessKind, locationIdentity, true);
  64     }
  65 
  66     public RawStoreNode(ValueNode object, ValueNode offset, ValueNode value, JavaKind accessKind, LocationIdentity locationIdentity, boolean needsBarrier) {
  67         this(object, offset, value, accessKind, locationIdentity, needsBarrier, null, false);
  68     }
  69 
  70     public RawStoreNode(ValueNode object, ValueNode offset, ValueNode value, JavaKind accessKind, LocationIdentity locationIdentity, boolean needsBarrier, FrameState stateAfter,
  71                     boolean forceAnyLocation) {
  72         super(TYPE, StampFactory.forVoid(), object, offset, accessKind, locationIdentity, forceAnyLocation);
  73         this.value = value;
  74         this.needsBarrier = needsBarrier;
  75         this.stateAfter = stateAfter;
  76         assert accessKind != JavaKind.Void && accessKind != JavaKind.Illegal;
  77     }
  78 
  79     @NodeIntrinsic
  80     public static native Object storeObject(Object object, long offset, Object value, @ConstantNodeParameter JavaKind kind, @ConstantNodeParameter LocationIdentity locationIdentity,
  81                     @ConstantNodeParameter boolean needsBarrier);
  82 
  83     @NodeIntrinsic
  84     public static native Object storeChar(Object object, long offset, char value, @ConstantNodeParameter JavaKind kind, @ConstantNodeParameter LocationIdentity locationIdentity);
  85 
  86     public boolean needsBarrier() {
  87         return needsBarrier;
  88     }
  89 
  90     @Override
  91     public FrameState stateAfter() {
  92         return stateAfter;
  93     }
  94 
  95     @Override
  96     public void setStateAfter(FrameState x) {
  97         assert x == null || x.isAlive() : "frame state must be in a graph";
  98         updateUsages(stateAfter, x);
  99         stateAfter = x;
 100     }
 101 
 102     @Override
 103     public boolean hasSideEffect() {
 104         return true;
 105     }
 106 
 107     public ValueNode value() {
 108         return value;
 109     }
 110 
 111     @Override
 112     public void lower(LoweringTool tool) {
 113         tool.getLowerer().lower(this, tool);
 114     }
 115 
 116     @Override
 117     public void virtualize(VirtualizerTool tool) {
 118         ValueNode alias = tool.getAlias(object());
 119         if (alias instanceof VirtualObjectNode) {
 120             VirtualObjectNode virtual = (VirtualObjectNode) alias;
 121             ValueNode indexValue = tool.getAlias(offset());
 122             if (indexValue.isConstant()) {
 123                 long off = indexValue.asJavaConstant().asLong();
 124                 int entryIndex = virtual.entryIndexForOffset(tool.getMetaAccess(), off, accessKind());
 125                 if (entryIndex != -1 && tool.setVirtualEntry(virtual, entryIndex, value(), accessKind(), off)) {
 126                     tool.delete();
 127                 }
 128             }
 129         }
 130     }
 131 
 132     @Override
 133     protected ValueNode cloneAsFieldAccess(Assumptions assumptions, ResolvedJavaField field, boolean volatileAccess) {
 134         return new StoreFieldNode(object(), field, value(), stateAfter(), volatileAccess);
 135     }
 136 
 137     @Override
 138     protected ValueNode cloneAsArrayAccess(ValueNode location, LocationIdentity identity) {
 139         return new RawStoreNode(object(), location, value, accessKind(), identity, needsBarrier, stateAfter(), isAnyLocationForced());
 140     }
 141 
 142     public FrameState getState() {
 143         return stateAfter;
 144     }
 145 }