/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package org.graalvm.compiler.nodes.java;

import static org.graalvm.compiler.nodeinfo.InputType.State;

import static org.graalvm.compiler.nodeinfo.NodeCycles.CYCLES_8;

import static org.graalvm.compiler.nodeinfo.NodeSize.SIZE_8;

import org.graalvm.compiler.core.common.type.StampFactory;

import org.graalvm.compiler.graph.Node;

import org.graalvm.compiler.graph.NodeClass;

import org.graalvm.compiler.graph.spi.Canonicalizable;

import org.graalvm.compiler.graph.spi.CanonicalizerTool;

import org.graalvm.compiler.nodeinfo.InputType;

import org.graalvm.compiler.nodeinfo.NodeInfo;

import org.graalvm.compiler.nodes.DeoptimizeNode;

import org.graalvm.compiler.nodes.FrameState;

import org.graalvm.compiler.nodes.StateSplit;

import org.graalvm.compiler.nodes.ValueNode;

import org.graalvm.compiler.nodes.extended.GuardingNode;

import org.graalvm.compiler.nodes.spi.Lowerable;

import org.graalvm.compiler.nodes.spi.Virtualizable;

import org.graalvm.compiler.nodes.spi.VirtualizerTool;

import org.graalvm.compiler.nodes.type.StampTool;

import org.graalvm.compiler.nodes.virtual.VirtualArrayNode;

import org.graalvm.compiler.nodes.virtual.VirtualObjectNode;

import jdk.vm.ci.meta.DeoptimizationAction;

import jdk.vm.ci.meta.DeoptimizationReason;

import jdk.vm.ci.meta.JavaKind;

import jdk.vm.ci.meta.ResolvedJavaType;

/**

 * The {@code StoreIndexedNode} represents a write to an array element.

 */

@NodeInfo(cycles = CYCLES_8, size = SIZE_8)

public final class StoreIndexedNode extends AccessIndexedNode implements StateSplit, Lowerable, Virtualizable, Canonicalizable {

    public static final NodeClass<StoreIndexedNode> TYPE = NodeClass.create(StoreIndexedNode.class);

    @OptionalInput(InputType.Guard) private GuardingNode storeCheck;

    @Input ValueNode value;

    @OptionalInput(State) FrameState stateAfter;

    public GuardingNode getStoreCheck() {

        return storeCheck;

    }

    @Override

    public FrameState stateAfter() {

        return stateAfter;

    }

    @Override

    public void setStateAfter(FrameState x) {

        assert x == null || x.isAlive() : "frame state must be in a graph";

        updateUsages(stateAfter, x);

        stateAfter = x;

    }

    @Override

    public boolean hasSideEffect() {

        return true;

    }

    public ValueNode value() {

        return value;

    }

    public StoreIndexedNode(ValueNode array, ValueNode index, GuardingNode boundsCheck, GuardingNode storeCheck, JavaKind elementKind, ValueNode value) {

        super(TYPE, StampFactory.forVoid(), array, index, boundsCheck, elementKind);

        this.storeCheck = storeCheck;

        this.value = value;

    }

    @Override

    public void virtualize(VirtualizerTool tool) {

        ValueNode alias = tool.getAlias(array());

        if (alias instanceof VirtualObjectNode) {

            ValueNode indexValue = tool.getAlias(index());

            int idx = indexValue.isConstant() ? indexValue.asJavaConstant().asInt() : -1;

            VirtualArrayNode virtual = (VirtualArrayNode) alias;

            if (idx >= 0 && idx < virtual.entryCount()) {

                ResolvedJavaType componentType = virtual.type().getComponentType();

                if (componentType.isPrimitive() || StampTool.isPointerAlwaysNull(value) || componentType.isJavaLangObject() ||

                                (StampTool.typeReferenceOrNull(value) != null && componentType.isAssignableFrom(StampTool.typeOrNull(value)))) {

                    tool.setVirtualEntry(virtual, idx, value());

                    tool.delete();

                }

            }

        }

    }

    public FrameState getState() {

        return stateAfter;

    }

    @Override

    public Node canonical(CanonicalizerTool tool) {

        if (array().isNullConstant()) {

            return new DeoptimizeNode(DeoptimizationAction.InvalidateReprofile, DeoptimizationReason.NullCheckException);

        }

        return this;

    }

}