/*
 * Copyright (c) 2022, 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 compiler.vectorapi;

import java.util.Random;
import jdk.incubator.vector.VectorMask;
import jdk.incubator.vector.VectorSpecies;
import jdk.incubator.vector.VectorOperators;
import jdk.incubator.vector.ShortVector;
import jdk.incubator.vector.IntVector;
import jdk.incubator.vector.LongVector;

import compiler.lib.ir_framework.*;
import jdk.test.lib.Utils;

/*
 * @test
 * @bug 8287794
 * @summary Test various reverse bytes ideal transforms on X86(AVX2, AVX512) and AArch64(NEON).
 *          For AArch64(SVE), we have a specific optimization,
 *          ReverseBytesV (ReverseBytesV X MASK) MASK => X, which eliminates both ReverseBytesV
 *          nodes. The test cases for AArch64(SVE) are in TestReverseByteTransformsSVE.java.
 * @requires vm.compiler2.enabled
 * @requires !(vm.cpu.features ~= ".*sve.*")
 * @modules jdk.incubator.vector
 * @library /test/lib /
 * @run driver compiler.vectorapi.TestReverseByteTransforms
 */

public class TestReverseByteTransforms {
    static final VectorSpecies<Long> LSPECIES = LongVector.SPECIES_MAX;
    static final VectorSpecies<Integer> ISPECIES = IntVector.SPECIES_MAX;
    static final VectorSpecies<Short> SSPECIES = ShortVector.SPECIES_MAX;

    static final int SIZE = 1024;
    static final int ITERS = 50000;

    static long [] lout = new long[SIZE];
    static long [] linp = new long[SIZE];

    static int [] iout = new int[SIZE];
    static int [] iinp = new int[SIZE];

    static short [] sout = new short[SIZE];
    static short [] sinp = new short[SIZE];

    static void init() {
        Random r = new Random(1024);
        for(int i = 0; i < SIZE; i++) {
            linp[i] = r.nextLong();
            iinp[i] = r.nextInt();
            sinp[i] = (short)r.nextInt();
        }
    }

    public static void main(String args[]) {
        init();
        TestFramework.runWithFlags("-XX:-TieredCompilation", "--add-modules=jdk.incubator.vector");
        System.out.println("PASSED");
    }

    @Test
    @IR(applyIfCPUFeatureOr = {"asimd", "true", "avx2", "true"}, counts = {IRNode.REVERSE_BYTES_VL, " > 0 "})
    public void test_reversebytes_long_transform1(long[] lout, long[] linp) {
        VectorMask<Long> mask = VectorMask.fromLong(LSPECIES, 3);
        for (int i = 0; i < LSPECIES.loopBound(linp.length); i+=LSPECIES.length()) {
            LongVector.fromArray(LSPECIES, linp, i)
                     .lanewise(VectorOperators.REVERSE_BYTES)
                     .lanewise(VectorOperators.REVERSE_BYTES, mask)
                     .intoArray(lout, i);
        }
    }

    @Run(test = {"test_reversebytes_long_transform1"}, mode = RunMode.STANDALONE)
    public void kernel_test_reversebytes_long_transform1() {
        for (int i = 0; i < ITERS; i++) {
            test_reversebytes_long_transform1(lout, linp);
        }
    }

    @Test
    @IR(applyIfCPUFeatureOr = {"asimd", "true", "avx2", "true"}, counts = {IRNode.REVERSE_BYTES_VL, " > 0 "})
    public void test_reversebytes_long_transform2(long[] lout, long[] linp) {
        VectorMask<Long> mask1 = VectorMask.fromLong(LSPECIES, 3);
        VectorMask<Long> mask2 = VectorMask.fromLong(LSPECIES, 3);
        for (int i = 0; i < LSPECIES.loopBound(linp.length); i+=LSPECIES.length()) {
            LongVector.fromArray(LSPECIES, linp, i)
                     .lanewise(VectorOperators.REVERSE_BYTES, mask1)
                     .lanewise(VectorOperators.REVERSE_BYTES, mask2)
                     .intoArray(lout, i);
        }
    }

    @Run(test = {"test_reversebytes_long_transform2"}, mode = RunMode.STANDALONE)
    public void kernel_test_reversebytes_long_transform2() {
        for (int i = 0; i < ITERS; i++) {
            test_reversebytes_long_transform2(lout, linp);
        }
    }

    @Test
    @IR(applyIfCPUFeatureOr = {"asimd", "true", "avx2", "true"}, failOn = {IRNode.REVERSE_BYTES_VL})
    public void test_reversebytes_long_transform3(long[] lout, long[] linp) {
        for (int i = 0; i < LSPECIES.loopBound(linp.length); i+=LSPECIES.length()) {
            LongVector.fromArray(LSPECIES, linp, i)
                     .lanewise(VectorOperators.REVERSE_BYTES)
                     .lanewise(VectorOperators.REVERSE_BYTES)
                     .intoArray(lout, i);
        }
    }

    @Run(test = {"test_reversebytes_long_transform3"}, mode = RunMode.STANDALONE)
    public void kernel_test_reversebytes_long_transform3() {
        for (int i = 0; i < ITERS; i++) {
            test_reversebytes_long_transform3(lout, linp);
        }
    }

    @Test
    @IR(applyIfCPUFeatureOr = {"asimd", "true", "avx2", "true"}, counts = {IRNode.REVERSE_BYTES_VI, " > 0 "})
    public void test_reversebytes_int_transform1(int[] iout, int[] iinp) {
        VectorMask<Integer> mask = VectorMask.fromLong(ISPECIES, 3);
        for (int i = 0; i < ISPECIES.loopBound(iinp.length); i+=ISPECIES.length()) {
            IntVector.fromArray(ISPECIES, iinp, i)
                     .lanewise(VectorOperators.REVERSE_BYTES)
                     .lanewise(VectorOperators.REVERSE_BYTES, mask)
                     .intoArray(iout, i);
        }
    }

    @Run(test = {"test_reversebytes_int_transform1"}, mode = RunMode.STANDALONE)
    public void kernel_test_reversebytes_int_transform1() {
        for (int i = 0; i < ITERS; i++) {
            test_reversebytes_int_transform1(iout, iinp);
        }
    }

    @Test
    @IR(applyIfCPUFeatureOr = {"asimd", "true", "avx2", "true"}, counts = {IRNode.REVERSE_BYTES_VI, " > 0 "})
    public void test_reversebytes_int_transform2(int[] iout, int[] iinp) {
        VectorMask<Integer> mask1 = VectorMask.fromLong(ISPECIES, 3);
        VectorMask<Integer> mask2 = VectorMask.fromLong(ISPECIES, 3);
        for (int i = 0; i < ISPECIES.loopBound(iinp.length); i+=ISPECIES.length()) {
            IntVector.fromArray(ISPECIES, iinp, i)
                     .lanewise(VectorOperators.REVERSE_BYTES, mask1)
                     .lanewise(VectorOperators.REVERSE_BYTES, mask2)
                     .intoArray(iout, i);
        }
    }

    @Run(test = {"test_reversebytes_int_transform2"}, mode = RunMode.STANDALONE)
    public void kernel_test_reversebytes_int_transform2() {
        for (int i = 0; i < ITERS; i++) {
            test_reversebytes_int_transform2(iout, iinp);
        }
    }

    @Test
    @IR(applyIfCPUFeatureOr = {"asimd", "true", "avx2", "true"}, failOn = {IRNode.REVERSE_BYTES_VI})
    public void test_reversebytes_int_transform3(int[] iout, int[] iinp) {
        for (int i = 0; i < ISPECIES.loopBound(iinp.length); i+=ISPECIES.length()) {
            IntVector.fromArray(ISPECIES, iinp, i)
                     .lanewise(VectorOperators.REVERSE_BYTES)
                     .lanewise(VectorOperators.REVERSE_BYTES)
                     .intoArray(iout, i);
        }
    }

    @Run(test = {"test_reversebytes_int_transform3"}, mode = RunMode.STANDALONE)
    public void kernel_test_reversebytes_int_transform3() {
        for (int i = 0; i < ITERS; i++) {
            test_reversebytes_int_transform3(iout, iinp);
        }
    }

    @Test
    @IR(applyIfCPUFeatureOr = {"asimd", "true", "avx2", "true"}, counts = {IRNode.REVERSE_BYTES_VS, " > 0 "})
    public void test_reversebytes_short_transform1(short[] sout, short[] sinp) {
        VectorMask<Short> mask = VectorMask.fromLong(SSPECIES, 3);
        for (int i = 0; i < SSPECIES.loopBound(sinp.length); i+=SSPECIES.length()) {
            ShortVector.fromArray(SSPECIES, sinp, i)
                     .lanewise(VectorOperators.REVERSE_BYTES)
                     .lanewise(VectorOperators.REVERSE_BYTES, mask)
                     .intoArray(sout, i);
        }
    }

    @Run(test = {"test_reversebytes_short_transform1"}, mode = RunMode.STANDALONE)
    public void kernel_test_reversebytes_short_transform1() {
        for (int i = 0; i < ITERS; i++) {
            test_reversebytes_short_transform1(sout, sinp);
        }
    }

    @Test
    @IR(applyIfCPUFeatureOr = {"asimd", "true", "avx2", "true"}, counts = {IRNode.REVERSE_BYTES_VS, " > 0 "})
    public void test_reversebytes_short_transform2(short[] sout, short[] sinp) {
        VectorMask<Short> mask1 = VectorMask.fromLong(SSPECIES, 3);
        VectorMask<Short> mask2 = VectorMask.fromLong(SSPECIES, 3);
        for (int i = 0; i < SSPECIES.loopBound(sinp.length); i+=SSPECIES.length()) {
            ShortVector.fromArray(SSPECIES, sinp, i)
                     .lanewise(VectorOperators.REVERSE_BYTES, mask1)
                     .lanewise(VectorOperators.REVERSE_BYTES, mask2)
                     .intoArray(sout, i);
        }
    }

    @Run(test = {"test_reversebytes_short_transform2"}, mode = RunMode.STANDALONE)
    public void kernel_test_reversebytes_short_transform2() {
        for (int i = 0; i < ITERS; i++) {
            test_reversebytes_short_transform2(sout, sinp);
        }
    }

    @Test
    @IR(applyIfCPUFeatureOr = {"asimd", "true", "avx2", "true"}, failOn = {IRNode.REVERSE_BYTES_VS})
    public void test_reversebytes_short_transform3(short[] sout, short[] sinp) {
        for (int i = 0; i < SSPECIES.loopBound(sinp.length); i+=SSPECIES.length()) {
            ShortVector.fromArray(SSPECIES, sinp, i)
                     .lanewise(VectorOperators.REVERSE_BYTES)
                     .lanewise(VectorOperators.REVERSE_BYTES)
                     .intoArray(sout, i);
        }
    }

    @Run(test = {"test_reversebytes_short_transform3"}, mode = RunMode.STANDALONE)
    public void kernel_test_reversebytes_short_transform3() {
        for (int i = 0; i < ITERS; i++) {
            test_reversebytes_short_transform3(sout, sinp);
        }
    }
}