/*

 * Copyright (c) 2012, 2016, 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.

 */

package org.graalvm.compiler.hotspot.replacements;

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

import static org.graalvm.compiler.core.common.calc.UnsignedMath.belowThan;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.CLASS_ARRAY_KLASS_LOCATION;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.HUB_WRITE_LOCATION;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.MARK_WORD_LOCATION;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.PROTOTYPE_MARK_WORD_LOCATION;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.TLAB_END_LOCATION;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.TLAB_TOP_LOCATION;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.arrayAllocationSize;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.arrayKlassOffset;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.arrayLengthOffset;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.config;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.initializeObjectHeader;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.instanceHeaderSize;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.isInstanceKlassFullyInitialized;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.layoutHelperHeaderSizeMask;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.layoutHelperHeaderSizeShift;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.layoutHelperLog2ElementSizeMask;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.layoutHelperLog2ElementSizeShift;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.loadKlassFromObject;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.prototypeMarkWordOffset;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.readLayoutHelper;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.readTlabEnd;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.readTlabTop;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.registerAsWord;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.useBiasedLocking;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.useTLAB;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.verifyOop;

import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.writeTlabTop;

import static org.graalvm.compiler.hotspot.replacements.HotspotSnippetsOptions.ProfileAllocations;

import static org.graalvm.compiler.hotspot.replacements.HotspotSnippetsOptions.ProfileAllocationsContext;

import static org.graalvm.compiler.nodes.PiArrayNode.piArrayCastToSnippetReplaceeStamp;

import static org.graalvm.compiler.nodes.PiNode.piCastToSnippetReplaceeStamp;

import static org.graalvm.compiler.nodes.extended.BranchProbabilityNode.FAST_PATH_PROBABILITY;

import static org.graalvm.compiler.nodes.extended.BranchProbabilityNode.FREQUENT_PROBABILITY;

import static org.graalvm.compiler.nodes.extended.BranchProbabilityNode.SLOW_PATH_PROBABILITY;

import static org.graalvm.compiler.nodes.extended.BranchProbabilityNode.probability;

import static org.graalvm.compiler.replacements.ReplacementsUtil.REPLACEMENTS_ASSERTIONS_ENABLED;

import static org.graalvm.compiler.replacements.ReplacementsUtil.runtimeAssert;

import static org.graalvm.compiler.replacements.ReplacementsUtil.staticAssert;

import static org.graalvm.compiler.replacements.SnippetTemplate.DEFAULT_REPLACER;

import static org.graalvm.compiler.replacements.nodes.CStringConstant.cstring;

import static org.graalvm.compiler.replacements.nodes.ExplodeLoopNode.explodeLoop;

import org.graalvm.compiler.api.replacements.Fold;

import org.graalvm.compiler.api.replacements.Snippet;

import org.graalvm.compiler.api.replacements.Snippet.ConstantParameter;

import org.graalvm.compiler.api.replacements.Snippet.VarargsParameter;

import org.graalvm.compiler.core.common.spi.ForeignCallDescriptor;

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

import org.graalvm.compiler.debug.DebugHandlersFactory;

import org.graalvm.compiler.debug.GraalError;

import org.graalvm.compiler.graph.Node.ConstantNodeParameter;

import org.graalvm.compiler.graph.Node.NodeIntrinsic;

import org.graalvm.compiler.hotspot.GraalHotSpotVMConfig;

import org.graalvm.compiler.hotspot.meta.HotSpotProviders;

import org.graalvm.compiler.hotspot.meta.HotSpotRegistersProvider;

import org.graalvm.compiler.hotspot.nodes.DimensionsNode;

import org.graalvm.compiler.hotspot.nodes.aot.LoadConstantIndirectlyFixedNode;

import org.graalvm.compiler.hotspot.nodes.aot.LoadConstantIndirectlyNode;

import org.graalvm.compiler.hotspot.nodes.type.KlassPointerStamp;

import org.graalvm.compiler.hotspot.word.KlassPointer;

import org.graalvm.compiler.nodes.ConstantNode;

import org.graalvm.compiler.nodes.DeoptimizeNode;

import org.graalvm.compiler.nodes.PiNode;

import org.graalvm.compiler.nodes.PrefetchAllocateNode;

import org.graalvm.compiler.nodes.SnippetAnchorNode;

import org.graalvm.compiler.nodes.StructuredGraph;

import org.graalvm.compiler.nodes.ValueNode;

import org.graalvm.compiler.nodes.debug.DynamicCounterNode;

import org.graalvm.compiler.nodes.debug.VerifyHeapNode;

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

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

import org.graalvm.compiler.nodes.java.DynamicNewArrayNode;

import org.graalvm.compiler.nodes.java.DynamicNewInstanceNode;

import org.graalvm.compiler.nodes.java.NewArrayNode;

import org.graalvm.compiler.nodes.java.NewInstanceNode;

import org.graalvm.compiler.nodes.java.NewMultiArrayNode;

import org.graalvm.compiler.nodes.memory.address.OffsetAddressNode;

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

import org.graalvm.compiler.nodes.util.GraphUtil;

import org.graalvm.compiler.options.OptionValues;

import org.graalvm.compiler.replacements.ReplacementsUtil;

import org.graalvm.compiler.replacements.SnippetCounter;

import org.graalvm.compiler.replacements.SnippetCounter.Group;

import org.graalvm.compiler.replacements.SnippetTemplate;

import org.graalvm.compiler.replacements.SnippetTemplate.AbstractTemplates;

import org.graalvm.compiler.replacements.SnippetTemplate.Arguments;

import org.graalvm.compiler.replacements.SnippetTemplate.SnippetInfo;

import org.graalvm.compiler.replacements.Snippets;

import org.graalvm.compiler.replacements.nodes.ExplodeLoopNode;

import org.graalvm.compiler.word.Word;

import jdk.internal.vm.compiler.word.LocationIdentity;

import jdk.internal.vm.compiler.word.WordFactory;

import jdk.vm.ci.code.CodeUtil;

import jdk.vm.ci.code.MemoryBarriers;

import jdk.vm.ci.code.Register;

import jdk.vm.ci.code.TargetDescription;

import jdk.vm.ci.hotspot.HotSpotResolvedObjectType;

import jdk.vm.ci.meta.JavaKind;

import jdk.vm.ci.meta.ResolvedJavaType;

/**

 * Snippets used for implementing NEW, ANEWARRAY and NEWARRAY.

 */

public class NewObjectSnippets implements Snippets {

    enum ProfileContext {

        AllocatingMethod,

        InstanceOrArray,

        AllocatedType,

        AllocatedTypesInMethod,

        Total

    }

    @Fold

    static String createName(String path, String typeContext, OptionValues options) {

        switch (ProfileAllocationsContext.getValue(options)) {

            case AllocatingMethod:

                return "";

            case InstanceOrArray:

                return path;

            case AllocatedType:

            case AllocatedTypesInMethod:

                return typeContext;

            case Total:

                return "bytes";

            default:

                throw GraalError.shouldNotReachHere();

        }

    }

    @Fold

    static boolean doProfile(OptionValues options) {

        return ProfileAllocations.getValue(options);

    }

    @Fold

    static boolean withContext(OptionValues options) {

        ProfileContext context = ProfileAllocationsContext.getValue(options);

        return context == ProfileContext.AllocatingMethod || context == ProfileContext.AllocatedTypesInMethod;

    }

    protected static void profileAllocation(String path, long size, String typeContext, OptionValues options) {

        if (doProfile(options)) {

            String name = createName(path, typeContext, options);

            boolean context = withContext(options);

            DynamicCounterNode.counter("number of bytes allocated", name, size, context);

            DynamicCounterNode.counter("number of allocations", name, 1, context);

        }

    }

    public static void emitPrefetchAllocate(Word address, boolean isArray) {

        GraalHotSpotVMConfig config = config(INJECTED_VMCONFIG);

        if (config.allocatePrefetchStyle > 0) {

            // Insert a prefetch for each allocation only on the fast-path

            // Generate several prefetch instructions.

            int lines = isArray ? config.allocatePrefetchLines : config.allocateInstancePrefetchLines;

            int stepSize = config.allocatePrefetchStepSize;

            int distance = config.allocatePrefetchDistance;

            ExplodeLoopNode.explodeLoop();

            for (int i = 0; i < lines; i++) {

                PrefetchAllocateNode.prefetch(OffsetAddressNode.address(address, distance));

                distance += stepSize;

            }

        }

    }

    @Snippet

    public static Object allocateInstance(@ConstantParameter int size, KlassPointer hub, Word prototypeMarkWord, @ConstantParameter boolean fillContents,

                    @ConstantParameter Register threadRegister, @ConstantParameter boolean constantSize, @ConstantParameter String typeContext, @ConstantParameter OptionValues options,

                    @ConstantParameter Counters counters) {

        return piCastToSnippetReplaceeStamp(allocateInstanceHelper(size, hub, prototypeMarkWord, fillContents, threadRegister, constantSize, typeContext, options, counters));

    }

    public static Object allocateInstanceHelper(int size, KlassPointer hub, Word prototypeMarkWord, boolean fillContents,

                    Register threadRegister, boolean constantSize, String typeContext, OptionValues options, Counters counters) {

        Object result;

        Word thread = registerAsWord(threadRegister);

        Word top = readTlabTop(thread);

        Word end = readTlabEnd(thread);

        Word newTop = top.add(size);

        if (useTLAB(INJECTED_VMCONFIG) && probability(FAST_PATH_PROBABILITY, newTop.belowOrEqual(end))) {

            writeTlabTop(thread, newTop);

            emitPrefetchAllocate(newTop, false);

            result = formatObject(hub, size, top, prototypeMarkWord, fillContents, constantSize, counters);

        } else {

            if (counters != null && counters.stub != null) {

                counters.stub.inc();

            }

        }

        profileAllocation("instance", size, typeContext, options);

        return verifyOop(result);

    }

    @NodeIntrinsic(value = ForeignCallNode.class, injectedStampIsNonNull = true)

    @Snippet

    public static Object allocateInstancePIC(@ConstantParameter int size, KlassPointer hub, Word prototypeMarkWord, @ConstantParameter boolean fillContents,

                    @ConstantParameter Register threadRegister, @ConstantParameter boolean constantSize, @ConstantParameter String typeContext, @ConstantParameter OptionValues options,

                    @ConstantParameter Counters counters) {

        // Klass must be initialized by the time the first instance is allocated, therefore we can

        // just load it from the corresponding cell and avoid the resolution check. We have to use a

        // fixed load though, to prevent it from floating above the initialization.

        KlassPointer picHub = LoadConstantIndirectlyFixedNode.loadKlass(hub);

        return piCastToSnippetReplaceeStamp(allocateInstanceHelper(size, picHub, prototypeMarkWord, fillContents, threadRegister, constantSize, typeContext, options, counters));

    }

    @Snippet

    public static Object allocateInstanceDynamic(Class<?> type, Class<?> classClass, @ConstantParameter boolean fillContents, @ConstantParameter Register threadRegister,

                    @ConstantParameter OptionValues options, @ConstantParameter Counters counters) {

        if (probability(SLOW_PATH_PROBABILITY, type == null)) {

        }

        Class<?> nonNullType = PiNode.piCastNonNullClass(type, SnippetAnchorNode.anchor());

        if (probability(SLOW_PATH_PROBABILITY, DynamicNewInstanceNode.throwsInstantiationException(type, classClass))) {

        }

    }

        KlassPointer hub = ClassGetHubNode.readClass(nonNullType);

        if (probability(FAST_PATH_PROBABILITY, !hub.isNull())) {

            KlassPointer nonNullHub = ClassGetHubNode.piCastNonNull(hub, SnippetAnchorNode.anchor());

            if (probability(FAST_PATH_PROBABILITY, isInstanceKlassFullyInitialized(nonNullHub))) {

                int layoutHelper = readLayoutHelper(nonNullHub);

                /*

                 * src/share/vm/oops/klass.hpp: For instances, layout helper is a positive number,

                 * the instance size. This size is already passed through align_object_size and

                 * scaled to bytes. The low order bit is set if instances of this class cannot be

                 * allocated using the fastpath.

                 */

                if (probability(FAST_PATH_PROBABILITY, (layoutHelper & 1) == 0)) {

                    Word prototypeMarkWord = nonNullHub.readWord(prototypeMarkWordOffset(INJECTED_VMCONFIG), PROTOTYPE_MARK_WORD_LOCATION);

                    /*

                     * FIXME(je,ds): we should actually pass typeContext instead of "" but late

                     * binding of parameters is not yet supported by the GraphBuilderPlugin system.

                     */

                    return allocateInstanceHelper(layoutHelper, nonNullHub, prototypeMarkWord, fillContents, threadRegister, false, "", options, counters);

                }

            } else {

            }

        }

    }

    /**

     * Maximum array length for which fast path allocation is used.

     */

    public static final int MAX_ARRAY_FAST_PATH_ALLOCATION_LENGTH = 0x00FFFFFF;

    @Snippet

    public static Object allocatePrimitiveArrayPIC(KlassPointer hub, int length, Word prototypeMarkWord, @ConstantParameter int headerSize, @ConstantParameter int log2ElementSize,

                    @ConstantParameter boolean fillContents, @ConstantParameter Register threadRegister, @ConstantParameter boolean maybeUnroll, @ConstantParameter String typeContext,

                    @ConstantParameter OptionValues options, @ConstantParameter Counters counters) {

        // Primitive array types are eagerly pre-resolved. We can use a floating load.

        KlassPointer picHub = LoadConstantIndirectlyNode.loadKlass(hub);

        return allocateArrayImpl(picHub, length, prototypeMarkWord, headerSize, log2ElementSize, fillContents, threadRegister, maybeUnroll, typeContext, false, options, counters);

    }

    @Snippet

    public static Object allocateArrayPIC(KlassPointer hub, int length, Word prototypeMarkWord, @ConstantParameter int headerSize, @ConstantParameter int log2ElementSize,

                    @ConstantParameter boolean fillContents, @ConstantParameter Register threadRegister, @ConstantParameter boolean maybeUnroll, @ConstantParameter String typeContext,

                    @ConstantParameter OptionValues options, @ConstantParameter Counters counters) {

        // Array type would be resolved by dominating resolution.

        KlassPointer picHub = LoadConstantIndirectlyFixedNode.loadKlass(hub);

        return allocateArrayImpl(picHub, length, prototypeMarkWord, headerSize, log2ElementSize, fillContents, threadRegister, maybeUnroll, typeContext, false, options, counters);

    }

    @Snippet

        Object result = allocateArrayImpl(hub, length, prototypeMarkWord, headerSize, log2ElementSize, fillContents, threadRegister, maybeUnroll, typeContext, false, options, counters);

        return piArrayCastToSnippetReplaceeStamp(verifyOop(result), length);

    }

    private static Object allocateArrayImpl(KlassPointer hub, int length, Word prototypeMarkWord, int headerSize, int log2ElementSize, boolean fillContents, Register threadRegister,

                    boolean maybeUnroll, String typeContext, boolean skipNegativeCheck, OptionValues options, Counters counters) {

        Object result;

        int allocationSize = arrayAllocationSize(length, headerSize, log2ElementSize);

        Word thread = registerAsWord(threadRegister);

        Word top = readTlabTop(thread);

        Word end = readTlabEnd(thread);

        Word newTop = top.add(allocationSize);

        if (probability(FREQUENT_PROBABILITY, skipNegativeCheck || belowThan(length, MAX_ARRAY_FAST_PATH_ALLOCATION_LENGTH)) && useTLAB(INJECTED_VMCONFIG) &&

                        probability(FAST_PATH_PROBABILITY, newTop.belowOrEqual(end))) {

            writeTlabTop(thread, newTop);

            emitPrefetchAllocate(newTop, true);

            if (counters != null && counters.arrayLoopInit != null) {

                counters.arrayLoopInit.inc();

            }

            result = formatArray(hub, allocationSize, length, headerSize, top, prototypeMarkWord, fillContents, maybeUnroll, counters);

        } else {

        }

        profileAllocation("array", allocationSize, typeContext, options);

        return result;

    }

    }

    @NodeIntrinsic(value = ForeignCallNode.class, injectedStampIsNonNull = true)

    @Snippet

    public static Object allocateArrayDynamic(Class<?> elementType, Class<?> voidClass, int length, @ConstantParameter boolean fillContents, @ConstantParameter Register threadRegister,

                    @ConstantParameter JavaKind knownElementKind, @ConstantParameter int knownLayoutHelper, Word prototypeMarkWord, @ConstantParameter OptionValues options,

                    @ConstantParameter Counters counters) {

        Object result = allocateArrayDynamicImpl(elementType, voidClass, length, fillContents, threadRegister, knownElementKind, knownLayoutHelper, prototypeMarkWord, options, counters);

        return result;

    }

    private static Object allocateArrayDynamicImpl(Class<?> elementType, Class<?> voidClass, int length, boolean fillContents, Register threadRegister, JavaKind knownElementKind,

                    int knownLayoutHelper, Word prototypeMarkWord, OptionValues options, Counters counters) {

        /*

         * We only need the dynamic check for void when we have no static information from

         * knownElementKind.

         */

        staticAssert(knownElementKind != JavaKind.Void, "unsupported knownElementKind");

        if (knownElementKind == JavaKind.Illegal && probability(SLOW_PATH_PROBABILITY, elementType == null || DynamicNewArrayNode.throwsIllegalArgumentException(elementType, voidClass))) {

        }

        KlassPointer klass = loadKlassFromObject(elementType, arrayKlassOffset(INJECTED_VMCONFIG), CLASS_ARRAY_KLASS_LOCATION);

        if (klass.isNull()) {

        }

        KlassPointer nonNullKlass = ClassGetHubNode.piCastNonNull(klass, SnippetAnchorNode.anchor());

        if (length < 0) {

        }

        int layoutHelper;

        if (knownElementKind == JavaKind.Illegal) {

            layoutHelper = readLayoutHelper(nonNullKlass);

        } else {

            runtimeAssert(knownLayoutHelper == readLayoutHelper(nonNullKlass), "layout mismatch");

            layoutHelper = knownLayoutHelper;

        }

        //@formatter:off

        // from src/share/vm/oops/klass.hpp:

        //

        // For arrays, layout helper is a negative number, containing four

        // distinct bytes, as follows:

        //    MSB:[tag, hsz, ebt, log2(esz)]:LSB

        // where:

        //    tag is 0x80 if the elements are oops, 0xC0 if non-oops

        //    hsz is array header size in bytes (i.e., offset of first element)

        //    ebt is the BasicType of the elements

        //    esz is the element size in bytes

        //@formatter:on

        int headerSize = (layoutHelper >> layoutHelperHeaderSizeShift(INJECTED_VMCONFIG)) & layoutHelperHeaderSizeMask(INJECTED_VMCONFIG);

        int log2ElementSize = (layoutHelper >> layoutHelperLog2ElementSizeShift(INJECTED_VMCONFIG)) & layoutHelperLog2ElementSizeMask(INJECTED_VMCONFIG);

        Object result = allocateArrayImpl(nonNullKlass, length, prototypeMarkWord, headerSize, log2ElementSize, fillContents, threadRegister, false, "dynamic type", true, options, counters);

        return piArrayCastToSnippetReplaceeStamp(verifyOop(result), length);

    }

    /**

     * Calls the runtime stub for implementing MULTIANEWARRAY.

     */

    @Snippet

        Word dims = DimensionsNode.allocaDimsArray(rank);

        ExplodeLoopNode.explodeLoop();

        for (int i = 0; i < rank; i++) {

            dims.writeInt(i * 4, dimensions[i], LocationIdentity.init());

        }

    }

    @Snippet

        // Array type would be resolved by dominating resolution.

        KlassPointer picHub = LoadConstantIndirectlyFixedNode.loadKlass(hub);

        return newmultiarray(picHub, rank, dimensions);

    }

    @NodeIntrinsic(value = ForeignCallNode.class, injectedStampIsNonNull = true)

    /**

     * Maximum number of long stores to emit when zeroing an object with a constant size. Larger

     * objects have their bodies initialized in a loop.

     */

    private static final int MAX_UNROLLED_OBJECT_ZEROING_STORES = 8;

    /**

     * Zero uninitialized memory in a newly allocated object, unrolling as necessary and ensuring

     * that stores are aligned.

     *

     * @param size number of bytes to zero

     * @param memory beginning of object which is being zeroed

     * @param constantSize is {@code size} known to be constant in the snippet