src/core/NEON/kernels/arm_gemm/transforms/sve_transpose_interleave_3VL_2x2.hpp

/*
 * Copyright (c) 2021 Arm Limited.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#pragma once

#ifdef __ARM_FEATURE_SVE


namespace {

void sve_transpose_interleave_3VL_2x2(uint16_t *out, const uint16_t *in, size_t width, size_t in_stride, size_t height)
{
    uint16_t *pad_row = reinterpret_cast<uint16_t *>(alloca(width * sizeof(uint16_t)));

    if (height % 2) {
        memset(pad_row, 0, width * sizeof(uint16_t));
    }

    size_t out_stride = 3 * roundup<size_t>(height, 2) * get_vector_length<uint16_t>();

    __asm__ __volatile__(
      "ptrue p2.b\n"
      "cmp %x[height], #0x8\n"
      "blt 6f\n"
      "1:"  // Main row loop: Head
      "mov x11, %x[in]\n"
      "mov x10, %x[out]\n"
      "add x9, x11, %x[in_stride]\n"
      "add x28, x9, %x[in_stride]\n"
      "add x27, x28, %x[in_stride]\n"
      "add x26, x27, %x[in_stride]\n"
      "add x25, x26, %x[in_stride]\n"
      "add x24, x25, %x[in_stride]\n"
      "add x23, x24, %x[in_stride]\n"
      "add %x[in], x23, %x[in_stride]\n"
      "sub %x[height], %x[height], #0x8\n"
      "mov x22, %x[width]\n"
      "cnth x21, ALL, MUL #3\n"
      "cmp x22, x21\n"
      "blt 3f\n"
      "2:"  // Main row loop: Unroll column loop
      "ld1h { z19.h }, p2/Z, [x11]\n"
      "mov x20, x10\n"
      "ld1h { z18.h }, p2/Z, [x11, #1, MUL VL]\n"
      "add x10, x10, %x[out_stride]\n"
      "ld1h { z21.h }, p2/Z, [x11, #2, MUL VL]\n"
      "addvl x11, x11, #3\n"
      "ld1h { z16.h }, p2/Z, [x9]\n"
      "zip1 z9.h, z19.h, z16.h\n"
      "ld1h { z17.h }, p2/Z, [x9, #1, MUL VL]\n"
      "mov x19, x10\n"
      "zip2 z8.h, z19.h, z16.h\n"
      "ld1h { z16.h }, p2/Z, [x9, #2, MUL VL]\n"
      "addvl x9, x9, #3\n"
      "zip1 z7.h, z18.h, z17.h\n"
      "ld1h { z19.h }, p2/Z, [x28]\n"
      "add x10, x10, %x[out_stride]\n"
      "zip2 z6.h, z18.h, z17.h\n"
      "ld1h { z20.h }, p2/Z, [x28, #1, MUL VL]\n"
      "sub x22, x22, x21\n"
      "zip1 z5.h, z21.h, z16.h\n"
      "ld1h { z18.h }, p2/Z, [x28, #2, MUL VL]\n"
      "addvl x28, x28, #3\n"
      "zip2 z4.h, z21.h, z16.h\n"
      "ld1h { z16.h }, p2/Z, [x27]\n"
      "cmp x22, x21\n"
      "zip1 z3.h, z19.h, z16.h\n"
      "ld1h { z17.h }, p2/Z, [x27, #1, MUL VL]\n"
      "zip2 z2.h, z19.h, z16.h\n"
      "ld1h { z16.h }, p2/Z, [x27, #2, MUL VL]\n"
      "addvl x27, x27, #3\n"
      "zip1 z1.h, z20.h, z17.h\n"
      "ld1h { z19.h }, p2/Z, [x26]\n"
      "zip2 z0.h, z20.h, z17.h\n"
      "ld1h { z21.h }, p2/Z, [x26, #1, MUL VL]\n"
      "zip1 z31.h, z18.h, z16.h\n"
      "ld1h { z20.h }, p2/Z, [x26, #2, MUL VL]\n"
      "addvl x26, x26, #3\n"
      "zip2 z30.h, z18.h, z16.h\n"
      "ld1h { z18.h }, p2/Z, [x25]\n"
      "ld1h { z17.h }, p2/Z, [x25, #1, MUL VL]\n"
      "zip1 z29.h, z19.h, z18.h\n"
      "ld1h { z16.h }, p2/Z, [x25, #2, MUL VL]\n"
      "addvl x25, x25, #3\n"
      "zip2 z28.h, z19.h, z18.h\n"
      "ld1h { z19.h }, p2/Z, [x24]\n"
      "zip1 z27.h, z21.h, z17.h\n"
      "ld1h { z26.h }, p2/Z, [x24, #1, MUL VL]\n"
      "zip2 z25.h, z21.h, z17.h\n"
      "ld1h { z24.h }, p2/Z, [x24, #2, MUL VL]\n"
      "addvl x24, x24, #3\n"
      "zip1 z23.h, z20.h, z16.h\n"
      "ld1h { z18.h }, p2/Z, [x23]\n"
      "zip2 z22.h, z20.h, z16.h\n"
      "ld1h { z17.h }, p2/Z, [x23, #1, MUL VL]\n"
      "ld1h { z16.h }, p2/Z, [x23, #2, MUL VL]\n"
      "zip1 z21.h, z19.h, z18.h\n"
      "st1h { z9.h }, p2, [x20]\n"
      "addvl x23, x23, #3\n"
      "zip2 z20.h, z19.h, z18.h\n"
      "st1h { z8.h }, p2, [x20, #1, MUL VL]\n"
      "zip1 z19.h, z26.h, z17.h\n"
      "st1h { z7.h }, p2, [x20, #2, MUL VL]\n"
      "zip2 z18.h, z26.h, z17.h\n"
      "st1h { z3.h }, p2, [x20, #3, MUL VL]\n"
      "zip1 z17.h, z24.h, z16.h\n"
      "st1h { z2.h }, p2, [x20, #4, MUL VL]\n"
      "zip2 z16.h, z24.h, z16.h\n"
      "st1h { z1.h }, p2, [x20, #5, MUL VL]\n"
      "st1h { z29.h }, p2, [x20, #6, MUL VL]\n"
      "st1h { z28.h }, p2, [x20, #7, MUL VL]\n"
      "addvl x20, x20, #12\n"
      "st1h { z27.h }, p2, [x20, #-4, MUL VL]\n"
      "st1h { z21.h }, p2, [x20, #-3, MUL VL]\n"
      "st1h { z20.h }, p2, [x20, #-2, MUL VL]\n"
      "st1h { z19.h }, p2, [x20, #-1, MUL VL]\n"
      "st1h { z6.h }, p2, [x19]\n"
      "st1h { z5.h }, p2, [x19, #1, MUL VL]\n"
      "st1h { z4.h }, p2, [x19, #2, MUL VL]\n"
      "st1h { z0.h }, p2, [x19, #3, MUL VL]\n"
      "st1h { z31.h }, p2, [x19, #4, MUL VL]\n"
      "st1h { z30.h }, p2, [x19, #5, MUL VL]\n"
      "st1h { z25.h }, p2, [x19, #6, MUL VL]\n"
      "st1h { z23.h }, p2, [x19, #7, MUL VL]\n"
      "addvl x19, x19, #12\n"
      "st1h { z22.h }, p2, [x19, #-4, MUL VL]\n"
      "st1h { z18.h }, p2, [x19, #-3, MUL VL]\n"
      "st1h { z17.h }, p2, [x19, #-2, MUL VL]\n"
      "st1h { z16.h }, p2, [x19, #-1, MUL VL]\n"
      "bge 2b\n"
      "3:"  // Main row loop: Unroll column loop skip
      "cbz x22, 5f\n"
      "4:"  // Main row loop: Column loop
      "mov x20, x22\n"
      "mov x19, x10\n"
      "whilelt p1.h, XZR, x20\n"
      "ld1h { z17.h }, p1/Z, [x11]\n"
      "ld1h { z16.h }, p1/Z, [x9]\n"
      "zip1 z29.h, z17.h, z16.h\n"
      "ld1h { z18.h }, p1/Z, [x28]\n"
      "dech x20\n"
      "zip2 z28.h, z17.h, z16.h\n"
      "ld1h { z16.h }, p1/Z, [x27]\n"
      "whilelt p0.h, XZR, x20\n"
      "zip1 z27.h, z18.h, z16.h\n"
      "ld1h { z17.h }, p0/Z, [x11, #1, MUL VL]\n"
      "addvl x11, x11, #1\n"
      "zip2 z26.h, z18.h, z16.h\n"
      "ld1h { z16.h }, p0/Z, [x9, #1, MUL VL]\n"
      "incd x11, ALL, MUL #4\n"
      "zip1 z25.h, z17.h, z16.h\n"
      "ld1h { z17.h }, p0/Z, [x28, #1, MUL VL]\n"
      "addvl x9, x9, #1\n"
      "ld1h { z16.h }, p0/Z, [x27, #1, MUL VL]\n"
      "zip1 z24.h, z17.h, z16.h\n"
      "ld1h { z19.h }, p1/Z, [x26]\n"
      "incd x9, ALL, MUL #4\n"
      "ld1h { z18.h }, p0/Z, [x26, #1, MUL VL]\n"
      "addvl x28, x28, #1\n"
      "ld1h { z17.h }, p1/Z, [x25]\n"
      "zip1 z23.h, z19.h, z17.h\n"
      "ld1h { z16.h }, p0/Z, [x25, #1, MUL VL]\n"
      "incd x28, ALL, MUL #4\n"
      "zip2 z22.h, z19.h, z17.h\n"
      "ld1h { z21.h }, p1/Z, [x24]\n"
      "addvl x27, x27, #1\n"
      "zip1 z20.h, z18.h, z16.h\n"
      "ld1h { z19.h }, p0/Z, [x24, #1, MUL VL]\n"
      "incd x27, ALL, MUL #4\n"
      "ld1h { z17.h }, p1/Z, [x23]\n"
      "zip1 z18.h, z21.h, z17.h\n"
      "ld1h { z16.h }, p0/Z, [x23, #1, MUL VL]\n"
      "addvl x26, x26, #1\n"
      "zip2 z17.h, z21.h, z17.h\n"
      "st1h { z29.h }, p2, [x19]\n"
      "incd x26, ALL, MUL #4\n"
      "zip1 z16.h, z19.h, z16.h\n"
      "st1h { z28.h }, p2, [x19, #1, MUL VL]\n"
      "addvl x25, x25, #1\n"
      "st1h { z25.h }, p2, [x19, #2, MUL VL]\n"
      "incd x25, ALL, MUL #4\n"
      "st1h { z27.h }, p2, [x19, #3, MUL VL]\n"
      "addvl x24, x24, #1\n"
      "st1h { z26.h }, p2, [x19, #4, MUL VL]\n"
      "incd x24, ALL, MUL #4\n"
      "st1h { z24.h }, p2, [x19, #5, MUL VL]\n"
      "addvl x23, x23, #1\n"
      "st1h { z23.h }, p2, [x19, #6, MUL VL]\n"
      "incd x23, ALL, MUL #4\n"
      "st1h { z22.h }, p2, [x19, #7, MUL VL]\n"
      "addvl x19, x19, #12\n"
      "add x10, x10, %x[out_stride]\n"
      "st1h { z20.h }, p2, [x19, #-4, MUL VL]\n"
      "st1h { z18.h }, p2, [x19, #-3, MUL VL]\n"
      "decw x22, ALL, MUL #3\n"
      "st1h { z17.h }, p2, [x19, #-2, MUL VL]\n"
      "cmp x22, #0x0\n"
      "st1h { z16.h }, p2, [x19, #-1, MUL VL]\n"
      "bgt 4b\n"
      "5:"  // Main row loop: Column loop skip
      "addvl %x[out], %x[out], #12\n"
      "cmp %x[height], #0x8\n"
      "bge 1b\n"
      "cbz %x[height], 12f\n"
      "6:"  // Main loop skip

      "7:"  // Tail row loop: Head
      "mov x11, %x[in]\n"
      "mov x10, %x[out]\n"
      "add x9, x11, %x[in_stride]\n"
      "add %x[in], x9, %x[in_stride]\n"
      "cmp %x[height], #0x1\n"
      "csel x9, x9, %x[pad_row], GT\n"
      "sub %x[height], %x[height], #0x2\n"
      "mov x20, %x[width]\n"
      "cnth x19, ALL, MUL #3\n"
      "cmp x20, x19\n"
      "blt 9f\n"
      "8:"  // Tail row loop: Unroll column loop
      "ld1h { z17.h }, p2/Z, [x11]\n"
      "sub x20, x20, x19\n"
      "ld1h { z22.h }, p2/Z, [x11, #1, MUL VL]\n"
      "cmp x20, x19\n"
      "ld1h { z21.h }, p2/Z, [x11, #2, MUL VL]\n"
      "addvl x11, x11, #3\n"
      "ld1h { z16.h }, p2/Z, [x9]\n"
      "zip1 z20.h, z17.h, z16.h\n"
      "ld1h { z18.h }, p2/Z, [x9, #1, MUL VL]\n"
      "zip2 z17.h, z17.h, z16.h\n"
      "ld1h { z19.h }, p2/Z, [x9, #2, MUL VL]\n"
      "addvl x9, x9, #3\n"
      "zip1 z16.h, z22.h, z18.h\n"
      "st1h { z20.h }, p2, [x10]\n"
      "zip2 z18.h, z22.h, z18.h\n"
      "st1h { z17.h }, p2, [x10, #1, MUL VL]\n"
      "zip1 z17.h, z21.h, z19.h\n"
      "st1h { z16.h }, p2, [x10, #2, MUL VL]\n"
      "add x10, x10, %x[out_stride]\n"
      "zip2 z16.h, z21.h, z19.h\n"
      "st1h { z18.h }, p2, [x10]\n"
      "st1h { z17.h }, p2, [x10, #1, MUL VL]\n"
      "st1h { z16.h }, p2, [x10, #2, MUL VL]\n"
      "add x10, x10, %x[out_stride]\n"
      "bge 8b\n"
      "9:"  // Tail row loop: Unroll column loop skip
      "cbz x20, 11f\n"
      "10:"  // Tail row loop: Column loop
      "mov x19, x20\n"
      "decw x20, ALL, MUL #3\n"
      "whilelt p0.h, XZR, x19\n"
      "ld1h { z17.h }, p0/Z, [x11]\n"
      "ld1h { z16.h }, p0/Z, [x9]\n"
      "zip1 z19.h, z17.h, z16.h\n"
      "dech x19\n"
      "zip2 z18.h, z17.h, z16.h\n"
      "whilelt p0.h, XZR, x19\n"
      "ld1h { z17.h }, p0/Z, [x11, #1, MUL VL]\n"
      "addvl x11, x11, #1\n"
      "ld1h { z16.h }, p0/Z, [x9, #1, MUL VL]\n"
      "zip1 z16.h, z17.h, z16.h\n"
      "st1h { z19.h }, p2, [x10]\n"
      "incd x11, ALL, MUL #4\n"
      "st1h { z18.h }, p2, [x10, #1, MUL VL]\n"
      "addvl x9, x9, #1\n"
      "st1h { z16.h }, p2, [x10, #2, MUL VL]\n"
      "incd x9, ALL, MUL #4\n"
      "add x10, x10, %x[out_stride]\n"
      "cmp x20, #0x0\n"
      "bgt 10b\n"
      "11:"  // Tail row loop: Column loop skip
      "addvl %x[out], %x[out], #3\n"
      "cmp %x[height], #0x1\n"
      "bge 7b\n"
      "12:"  // Done

      : [height] "+&r" (height), [in] "+&r" (in), [out] "+&r" (out)
      : [in_stride] "r" (in_stride), [out_stride] "r" (out_stride), [pad_row] "r" (pad_row), [width] "r" (width)
      : "cc", "memory", "p0", "p1", "p2", "x9", "x10", "x11", "x19", "x20", "x21", "x22", "x23", "x24", "x25", "x26", "x27", "x28", "z0", "z1", "z2", "z3", "z4", "z5", "z6", "z7", "z8", "z9", "z16", "z17", "z18", "z19", "z20", "z21", "z22", "z23", "z24", "z25", "z26", "z27", "z28", "z29", "z30", "z31"
    );
}

} // anonymous namespace

template<>
void Transform<3, 2, true, VLType::SVE>(
    bfloat16 *out, const bfloat16 *in, int stride, int x0, int xmax, int k0, int kmax)
{
    sve_transpose_interleave_3VL_2x2(
        reinterpret_cast<uint16_t *>(out),
        reinterpret_cast<const uint16_t *>(in + k0 * stride + x0),
        (xmax-x0) * sizeof(bfloat16) / 2,
        stride * sizeof(bfloat16),
        (kmax-k0)
    );
}

#endif