/*

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

 */

/*

 * @test

 * @run testng/othervm -Diters=20000 -XX:TieredStopAtLevel=1 VarHandleTestByteArrayAs$Type$

 * @run testng/othervm -Diters=20000                         VarHandleTestByteArrayAs$Type$

 * @run testng/othervm -Diters=20000 -XX:-TieredCompilation  VarHandleTestByteArrayAs$Type$

 */

import org.testng.annotations.DataProvider;

import org.testng.annotations.Test;

import java.lang.invoke.MethodHandles;

import java.lang.invoke.VarHandle;

import java.nio.ByteBuffer;

import java.nio.ByteOrder;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.EnumSet;

import java.util.List;

import static org.testng.Assert.*;

public class VarHandleTestByteArrayAs$Type$ extends VarHandleBaseByteArrayTest {

    static final int SIZE = $BoxType$.BYTES;

    static final $type$ VALUE_1 = $value1$;

    static final $type$ VALUE_2 = $value2$;

    static final $type$ VALUE_3 = $value3$;

    @Override

    public void setupVarHandleSources() {

        // Combinations of VarHandle byte[] or ByteBuffer

        vhss = new ArrayList<>();

        for (MemoryMode endianess : Arrays.asList(MemoryMode.BIG_ENDIAN, MemoryMode.LITTLE_ENDIAN)) {

            VarHandleSource aeh = new VarHandleSource(

                    MethodHandles.byteArrayViewVarHandle($type$[].class,

                                                         endianess == MemoryMode.BIG_ENDIAN),

                    endianess, MemoryMode.READ_WRITE);

            vhss.add(aeh);

            VarHandleSource bbh = new VarHandleSource(

                    MethodHandles.byteBufferViewVarHandle($type$[].class,

                                                          endianess == MemoryMode.BIG_ENDIAN),

                    endianess, MemoryMode.READ_WRITE);

            vhss.add(bbh);

        }

    }

    @Test(dataProvider = "varHandlesProvider")

    public void testIsAccessModeSupported(VarHandleSource vhs) {

        VarHandle vh = vhs.s;

#if[CAS]

#else[CAS]

#end[CAS]

#if[AtomicAdd]

#else[AtomicAdd]

#end[AtomicAdd]

    }

    @Test(dataProvider = "typesProvider")

    public void testTypes(VarHandle vh, List<java.lang.Class<?>> pts) {

        assertEquals(vh.varType(), $type$.class);

        assertEquals(vh.coordinateTypes(), pts);

        testTypes(vh);

    }

    @DataProvider

    public Object[][] accessTestCaseProvider() throws Exception {

        List<AccessTestCase<?>> cases = new ArrayList<>();

        for (ByteArrayViewSource<?> bav : bavss) {

            for (VarHandleSource vh : vhss) {

                if (vh.matches(bav)) {

                    if (bav instanceof ByteArraySource) {

                        ByteArraySource bas = (ByteArraySource) bav;

                        cases.add(new VarHandleSourceAccessTestCase(

                                "read write", bav, vh, h -> testArrayReadWrite(bas, h),

                                true));

                        cases.add(new VarHandleSourceAccessTestCase(

                                "unsupported", bav, vh, h -> testArrayUnsupported(bas, h),

                                false));

                        cases.add(new VarHandleSourceAccessTestCase(

                                "index out of bounds", bav, vh, h -> testArrayIndexOutOfBounds(bas, h),

                                false));

                        cases.add(new VarHandleSourceAccessTestCase(

                                "misaligned access", bav, vh, h -> testArrayMisalignedAccess(bas, h),

                                false));

                    }

                    else {

                        ByteBufferSource bbs = (ByteBufferSource) bav;

                        if (MemoryMode.READ_WRITE.isSet(bav.memoryModes)) {

                            cases.add(new VarHandleSourceAccessTestCase(

                                    "read write", bav, vh, h -> testArrayReadWrite(bbs, h),

                                    true));

                        }

                        else {

                            cases.add(new VarHandleSourceAccessTestCase(

                                    "read only", bav, vh, h -> testArrayReadOnly(bbs, h),

                                    true));

                        }

                        cases.add(new VarHandleSourceAccessTestCase(

                                "unsupported", bav, vh, h -> testArrayUnsupported(bbs, h),

                                false));

                        cases.add(new VarHandleSourceAccessTestCase(

                                "index out of bounds", bav, vh, h -> testArrayIndexOutOfBounds(bbs, h),

                                false));

                        cases.add(new VarHandleSourceAccessTestCase(

                                "misaligned access", bav, vh, h -> testArrayMisalignedAccess(bbs, h),

                                false));

                    }

                }

            }

        }

        // Work around issue with jtreg summary reporting which truncates

        // the String result of Object.toString to 30 characters, hence

        // the first dummy argument

        return cases.stream().map(tc -> new Object[]{tc.toString(), tc}).toArray(Object[][]::new);

    }

    @Test(dataProvider = "accessTestCaseProvider")

    public <T> void testAccess(String desc, AccessTestCase<T> atc) throws Throwable {

        T t = atc.get();

        int iters = atc.requiresLoop() ? ITERS : 1;

        for (int c = 0; c < iters; c++) {

            atc.testAccess(t);

        }

    }

    static void testArrayUnsupported(ByteArraySource bs, VarHandleSource vhs) {

        VarHandle vh = vhs.s;

        byte[] array = bs.s;

        int ci = 1;

#if[!CAS]

        checkUOE(() -> {

            boolean r = vh.compareAndSet(array, ci, VALUE_1, VALUE_2);

        });

        checkUOE(() -> {

            $type$ r = ($type$) vh.compareAndExchangeVolatile(array, ci, VALUE_2, VALUE_1);

        });

        checkUOE(() -> {

            $type$ r = ($type$) vh.compareAndExchangeAcquire(array, ci, VALUE_2, VALUE_1);

        });

        checkUOE(() -> {

            $type$ r = ($type$) vh.compareAndExchangeRelease(array, ci, VALUE_2, VALUE_1);

        });

        checkUOE(() -> {

            boolean r = vh.weakCompareAndSet(array, ci, VALUE_1, VALUE_2);

        });

        checkUOE(() -> {

            boolean r = vh.weakCompareAndSetAcquire(array, ci, VALUE_1, VALUE_2);

        });

        checkUOE(() -> {

            boolean r = vh.weakCompareAndSetRelease(array, ci, VALUE_1, VALUE_2);

        });

        checkUOE(() -> {

            $type$ o = ($type$) vh.getAndSet(array, ci, VALUE_1);

        });

#end[CAS]

#if[!AtomicAdd]

        checkUOE(() -> {

            $type$ o = ($type$) vh.getAndAdd(array, ci, VALUE_1);

        });

        checkUOE(() -> {

            $type$ o = ($type$) vh.addAndGet(array, ci, VALUE_1);

        });

#end[AtomicAdd]

    }

    static void testArrayUnsupported(ByteBufferSource bs, VarHandleSource vhs) {

        VarHandle vh = vhs.s;

        ByteBuffer array = bs.s;

        int ci = 0;

        boolean readOnly = MemoryMode.READ_ONLY.isSet(bs.memoryModes);

        if (readOnly) {

            checkROBE(() -> {

                vh.set(array, ci, VALUE_1);

            });

        }

        if (readOnly) {

            checkROBE(() -> {

                vh.setVolatile(array, ci, VALUE_1);

            });

            checkROBE(() -> {

                vh.setRelease(array, ci, VALUE_1);

            });

            checkROBE(() -> {

                vh.setOpaque(array, ci, VALUE_1);

            });

#if[CAS]

            checkROBE(() -> {

                boolean r = vh.compareAndSet(array, ci, VALUE_1, VALUE_2);

            });

            checkROBE(() -> {

                $type$ r = ($type$) vh.compareAndExchangeVolatile(array, ci, VALUE_2, VALUE_1);

            });

            checkROBE(() -> {

                $type$ r = ($type$) vh.compareAndExchangeAcquire(array, ci, VALUE_2, VALUE_1);

            });

            checkROBE(() -> {

                $type$ r = ($type$) vh.compareAndExchangeRelease(array, ci, VALUE_2, VALUE_1);

            });

            checkROBE(() -> {

                boolean r = vh.weakCompareAndSet(array, ci, VALUE_1, VALUE_2);

            });

            checkROBE(() -> {

                boolean r = vh.weakCompareAndSetAcquire(array, ci, VALUE_1, VALUE_2);

            });

            checkROBE(() -> {

                boolean r = vh.weakCompareAndSetRelease(array, ci, VALUE_1, VALUE_2);

            });

            checkROBE(() -> {

                $type$ o = ($type$) vh.getAndSet(array, ci, VALUE_1);

            });

            checkUOE(() -> {

                boolean r = vh.compareAndSet(array, ci, VALUE_1, VALUE_2);

            });

#else[CAS]

            checkUOE(() -> {

                $type$ r = ($type$) vh.compareAndExchangeVolatile(array, ci, VALUE_2, VALUE_1);

            });

            checkUOE(() -> {

                $type$ r = ($type$) vh.compareAndExchangeAcquire(array, ci, VALUE_2, VALUE_1);

            });

            checkUOE(() -> {

                $type$ r = ($type$) vh.compareAndExchangeRelease(array, ci, VALUE_2, VALUE_1);

            });

            checkUOE(() -> {

                boolean r = vh.weakCompareAndSet(array, ci, VALUE_1, VALUE_2);

            });

            checkUOE(() -> {

                boolean r = vh.weakCompareAndSetAcquire(array, ci, VALUE_1, VALUE_2);

            });

            checkUOE(() -> {

                boolean r = vh.weakCompareAndSetRelease(array, ci, VALUE_1, VALUE_2);

            });

            checkUOE(() -> {

                $type$ o = ($type$) vh.getAndSet(array, ci, VALUE_1);

            });

#end[CAS]

#if[AtomicAdd]

            checkROBE(() -> {

                $type$ o = ($type$) vh.getAndAdd(array, ci, VALUE_1);

            });

            checkROBE(() -> {

                $type$ o = ($type$) vh.addAndGet(array, ci, VALUE_1);

            });

#else[AtomicAdd]

            checkUOE(() -> {

                $type$ o = ($type$) vh.getAndAdd(array, ci, VALUE_1);

            });

            checkUOE(() -> {

                $type$ o = ($type$) vh.addAndGet(array, ci, VALUE_1);

            });

#end[AtomicAdd]

        }

        else {

#if[!CAS]

            checkUOE(() -> {

                boolean r = vh.compareAndSet(array, ci, VALUE_1, VALUE_2);

            });

            checkUOE(() -> {

                $type$ r = ($type$) vh.compareAndExchangeVolatile(array, ci, VALUE_2, VALUE_1);

            });

            checkUOE(() -> {

                $type$ r = ($type$) vh.compareAndExchangeAcquire(array, ci, VALUE_2, VALUE_1);

            });

            checkUOE(() -> {

                $type$ r = ($type$) vh.compareAndExchangeRelease(array, ci, VALUE_2, VALUE_1);

            });

            checkUOE(() -> {

                boolean r = vh.weakCompareAndSet(array, ci, VALUE_1, VALUE_2);

            });

            checkUOE(() -> {

                boolean r = vh.weakCompareAndSetAcquire(array, ci, VALUE_1, VALUE_2);

            });

            checkUOE(() -> {

                boolean r = vh.weakCompareAndSetRelease(array, ci, VALUE_1, VALUE_2);

            });

            checkUOE(() -> {

                $type$ o = ($type$) vh.getAndSet(array, ci, VALUE_1);

            });

#end[CAS]

#if[!AtomicAdd]

            checkUOE(() -> {

                $type$ o = ($type$) vh.getAndAdd(array, ci, VALUE_1);

            });

            checkUOE(() -> {

                $type$ o = ($type$) vh.addAndGet(array, ci, VALUE_1);

            });

#end[AtomicAdd]

        }

    }

    static void testArrayIndexOutOfBounds(ByteArraySource bs, VarHandleSource vhs) throws Throwable {

        VarHandle vh = vhs.s;

        byte[] array = bs.s;

        int length = array.length - SIZE + 1;

        for (int i : new int[]{-1, Integer.MIN_VALUE, length, length + 1, Integer.MAX_VALUE}) {

            final int ci = i;

            checkIOOBE(() -> {

                $type$ x = ($type$) vh.get(array, ci);

            });

            checkIOOBE(() -> {

                vh.set(array, ci, VALUE_1);

            });

            checkIOOBE(() -> {

                $type$ x = ($type$) vh.getVolatile(array, ci);

            });

            checkIOOBE(() -> {

                $type$ x = ($type$) vh.getAcquire(array, ci);

            });

            checkIOOBE(() -> {

                $type$ x = ($type$) vh.getOpaque(array, ci);

            });

            checkIOOBE(() -> {

                vh.setVolatile(array, ci, VALUE_1);

            });

            checkIOOBE(() -> {

                vh.setRelease(array, ci, VALUE_1);

            });

            checkIOOBE(() -> {

                vh.setOpaque(array, ci, VALUE_1);

            });

#if[CAS]

            checkIOOBE(() -> {

                boolean r = vh.compareAndSet(array, ci, VALUE_1, VALUE_2);

            });

            checkIOOBE(() -> {

                $type$ r = ($type$) vh.compareAndExchangeVolatile(array, ci, VALUE_2, VALUE_1);

            });

            checkIOOBE(() -> {

                $type$ r = ($type$) vh.compareAndExchangeAcquire(array, ci, VALUE_2, VALUE_1);

            });

            checkIOOBE(() -> {

                $type$ r = ($type$) vh.compareAndExchangeRelease(array, ci, VALUE_2, VALUE_1);

            });

            checkIOOBE(() -> {

                boolean r = vh.weakCompareAndSet(array, ci, VALUE_1, VALUE_2);

            });

            checkIOOBE(() -> {

                boolean r = vh.weakCompareAndSetAcquire(array, ci, VALUE_1, VALUE_2);

            });

            checkIOOBE(() -> {

                boolean r = vh.weakCompareAndSetRelease(array, ci, VALUE_1, VALUE_2);

            });

            checkIOOBE(() -> {

                $type$ o = ($type$) vh.getAndSet(array, ci, VALUE_1);

            });

#end[CAS]

#if[AtomicAdd]

            checkIOOBE(() -> {

                $type$ o = ($type$) vh.getAndAdd(array, ci, VALUE_1);

            });

            checkIOOBE(() -> {

                $type$ o = ($type$) vh.addAndGet(array, ci, VALUE_1);

            });

#end[AtomicAdd]

        }

    }

    static void testArrayIndexOutOfBounds(ByteBufferSource bs, VarHandleSource vhs) throws Throwable {

        VarHandle vh = vhs.s;

        ByteBuffer array = bs.s;

        boolean readOnly = MemoryMode.READ_ONLY.isSet(bs.memoryModes);

        int length = array.limit() - SIZE + 1;

        for (int i : new int[]{-1, Integer.MIN_VALUE, length, length + 1, Integer.MAX_VALUE}) {

            final int ci = i;

            checkIOOBE(() -> {

                $type$ x = ($type$) vh.get(array, ci);

            });

            if (!readOnly) {

                checkIOOBE(() -> {

                    vh.set(array, ci, VALUE_1);

                });

            }

            checkIOOBE(() -> {

                $type$ x = ($type$) vh.getVolatile(array, ci);

            });

            checkIOOBE(() -> {

                $type$ x = ($type$) vh.getAcquire(array, ci);

            });

            checkIOOBE(() -> {

                $type$ x = ($type$) vh.getOpaque(array, ci);

            });

            if (!readOnly) {

                checkIOOBE(() -> {

                    vh.setVolatile(array, ci, VALUE_1);

                });

                checkIOOBE(() -> {

                    vh.setRelease(array, ci, VALUE_1);

                });