/*

 * Copyright (c) 2013, 2015, Oracle and/or its affiliates. All rights reserved.

 * 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.

 */

//JaCoCo Exclude

package org.graalvm.compiler.nodes.java;

import static org.graalvm.compiler.core.common.GraalOptions.GeneratePIC;

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

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

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

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.NodeInfo;

import org.graalvm.compiler.nodes.FrameState;

import org.graalvm.compiler.nodes.ValueNode;

import jdk.vm.ci.meta.JavaKind;

import jdk.vm.ci.meta.MetaAccessProvider;

import jdk.vm.ci.meta.ResolvedJavaType;

/**

 * The {@code DynamicNewArrayNode} is used for allocation of arrays when the type is not a

 * compile-time constant.

 */

@NodeInfo

public class DynamicNewArrayNode extends AbstractNewArrayNode implements Canonicalizable {

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

    @Input ValueNode elementType;

    /**

     * Class pointer to void.class needs to be exposed earlier than this node is lowered so that it

     * can be replaced by the AOT machinery. If it's not needed for lowering this input can be

     * ignored.

     */

    @OptionalInput ValueNode voidClass;

    /**

     * A non-null value indicating the worst case element type. Mainly useful for distinguishing

     * Object arrays from primitive arrays.

     */

    protected final JavaKind knownElementKind;

    public DynamicNewArrayNode(ValueNode elementType, ValueNode length, boolean fillContents) {

        this(TYPE, elementType, length, fillContents, null, null, null);

    }

    public DynamicNewArrayNode(@InjectedNodeParameter MetaAccessProvider metaAccess, ValueNode elementType, ValueNode length, boolean fillContents, JavaKind knownElementKind) {

        this(TYPE, elementType, length, fillContents, knownElementKind, null, metaAccess);

    }

    private static Stamp computeStamp(JavaKind knownElementKind, MetaAccessProvider metaAccess) {

        if (knownElementKind != null && metaAccess != null) {

            ResolvedJavaType arrayType = metaAccess.lookupJavaType(knownElementKind == JavaKind.Object ? Object.class : knownElementKind.toJavaClass()).getArrayClass();

            return StampFactory.objectNonNull(TypeReference.createWithoutAssumptions(arrayType));

        }

        return StampFactory.objectNonNull();

    }

    protected DynamicNewArrayNode(NodeClass<? extends DynamicNewArrayNode> c, ValueNode elementType, ValueNode length, boolean fillContents, JavaKind knownElementKind, FrameState stateBefore,

                    MetaAccessProvider metaAccess) {

        super(c, computeStamp(knownElementKind, metaAccess), length, fillContents, stateBefore);

        this.elementType = elementType;

        this.knownElementKind = knownElementKind;

        assert knownElementKind != JavaKind.Void && knownElementKind != JavaKind.Illegal;

    }

    public ValueNode getElementType() {

        return elementType;

    }

    public JavaKind getKnownElementKind() {

        return knownElementKind;

    }

    @Override

    public Node canonical(CanonicalizerTool tool) {

        if (elementType.isConstant()) {

            if (GeneratePIC.getValue(tool.getOptions())) {

                // Can't fold for AOT, because the resulting NewArrayNode will be missing its

                // ResolveConstantNode for the array class.

                return this;

            }

            ResolvedJavaType type = tool.getConstantReflection().asJavaType(elementType.asConstant());

            if (type != null && !throwsIllegalArgumentException(type)) {

                return createNewArrayNode(type);

            }

        }

        return this;

    }

    /** Hook for subclasses to instantiate a subclass of {@link NewArrayNode}. */

    protected NewArrayNode createNewArrayNode(ResolvedJavaType type) {

        return new NewArrayNode(type, length(), fillContents(), stateBefore());

    }

    public static boolean throwsIllegalArgumentException(Class<?> elementType, Class<?> voidClass) {

        return elementType == voidClass;

    }

    public static boolean throwsIllegalArgumentException(ResolvedJavaType elementType) {

        return elementType.getJavaKind() == JavaKind.Void;

    }

    @NodeIntrinsic

    private static native Object newArray(Class<?> componentType, int length, @ConstantNodeParameter boolean fillContents, @ConstantNodeParameter JavaKind knownElementKind);

    public static Object newArray(Class<?> componentType, int length, JavaKind knownElementKind) {

        return newArray(componentType, length, true, knownElementKind);

    }

    public static Object newUninitializedArray(Class<?> componentType, int length, JavaKind knownElementKind) {

        return newArray(componentType, length, false, knownElementKind);

    }

    public ValueNode getVoidClass() {

        return voidClass;

    }

    public void setVoidClass(ValueNode newVoidClass) {

        updateUsages(voidClass, newVoidClass);

        voidClass = newVoidClass;

    }

}