git.sesse.net Git - stockfish/blob - src/nnue/layers/affine_transform_sparse_input.h

   1 /*
   2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   3   Copyright (C) 2004-2023 The Stockfish developers (see AUTHORS file)
   4
   5   Stockfish is free software: you can redistribute it and/or modify
   6   it under the terms of the GNU General Public License as published by
   7   the Free Software Foundation, either version 3 of the License, or
   8   (at your option) any later version.
   9
  10   Stockfish is distributed in the hope that it will be useful,
  11   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13   GNU General Public License for more details.
  14
  15   You should have received a copy of the GNU General Public License
  16   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18
  19 // Definition of layer AffineTransformSparseInput of NNUE evaluation function
  20
  21 #ifndef NNUE_LAYERS_AFFINE_TRANSFORM_SPARSE_INPUT_H_INCLUDED
  22 #define NNUE_LAYERS_AFFINE_TRANSFORM_SPARSE_INPUT_H_INCLUDED
  23
  24 #include <algorithm>
  25 #include <array>
  26 #include <cstdint>
  27 #include <iostream>
  28
  29 #include "../../bitboard.h"
  30 #include "../nnue_common.h"
  31 #include "affine_transform.h"
  32 #include "simd.h"
  33
  34 /*
  35   This file contains the definition for a fully connected layer (aka affine transform) with block sparse input.
  36 */
  37
  38 namespace Stockfish::Eval::NNUE::Layers {
  39
  40 #if (USE_SSSE3 | (USE_NEON >= 8))
  41   alignas(CacheLineSize) static inline const std::array<std::array<std::uint16_t, 8>, 256> lookup_indices = [](){
  42     std::array<std::array<std::uint16_t, 8>, 256> v{};
  43     for (unsigned i = 0; i < 256; ++i)
  44     {
  45       std::uint64_t j = i, k = 0;
  46       while(j)
  47         v[i][k++] = pop_lsb(j);
  48     }
  49     return v;
  50   }();
  51
  52   // Find indices of nonzero numbers in an int32_t array
  53   template<const IndexType InputDimensions>
  54   void find_nnz(const std::int32_t* input, std::uint16_t* out, IndexType& count_out) {
  55 #if defined (USE_SSSE3)
  56     #if defined (USE_AVX512)
  57         using vec_t = __m512i;
  58         #define vec_nnz(a) _mm512_cmpgt_epi32_mask(a, _mm512_setzero_si512())
  59     #elif defined (USE_AVX2)
  60         using vec_t = __m256i;
  61         #if defined(USE_VNNI) && !defined(USE_AVXVNNI)
  62             #define vec_nnz(a) _mm256_cmpgt_epi32_mask(a, _mm256_setzero_si256())
  63         #else
  64             #define vec_nnz(a) _mm256_movemask_ps(_mm256_castsi256_ps(_mm256_cmpgt_epi32(a, _mm256_setzero_si256())))
  65         #endif
  66     #elif defined (USE_SSSE3)
  67         using vec_t = __m128i;
  68         #define vec_nnz(a) _mm_movemask_ps(_mm_castsi128_ps(_mm_cmpgt_epi32(a, _mm_setzero_si128())))
  69     #endif
  70     using vec128_t = __m128i;
  71     #define vec128_zero _mm_setzero_si128()
  72     #define vec128_set_16(a) _mm_set1_epi16(a)
  73     #define vec128_load(a) _mm_load_si128(a)
  74     #define vec128_storeu(a, b) _mm_storeu_si128(a, b)
  75     #define vec128_add(a, b) _mm_add_epi16(a, b)
  76 #elif defined (USE_NEON)
  77     using vec_t = uint32x4_t;
  78     static const std::uint32_t Mask[4] = {1, 2, 4, 8};
  79     #define vec_nnz(a) vaddvq_u32(vandq_u32(vtstq_u32(a, a), vld1q_u32(Mask)))
  80     using vec128_t = uint16x8_t;
  81     #define vec128_zero vdupq_n_u16(0)
  82     #define vec128_set_16(a) vdupq_n_u16(a)
  83     #define vec128_load(a) vld1q_u16(reinterpret_cast<const std::uint16_t*>(a))
  84     #define vec128_storeu(a, b) vst1q_u16(reinterpret_cast<std::uint16_t*>(a), b)
  85     #define vec128_add(a, b) vaddq_u16(a, b)
  86 #endif
  87     constexpr IndexType InputSimdWidth = sizeof(vec_t) / sizeof(std::int32_t);
  88     // Inputs are processed InputSimdWidth at a time and outputs are processed 8 at a time so we process in chunks of max(InputSimdWidth, 8)
  89     constexpr IndexType ChunkSize = std::max<IndexType>(InputSimdWidth, 8);
  90     constexpr IndexType NumChunks = InputDimensions / ChunkSize;
  91     constexpr IndexType InputsPerChunk = ChunkSize / InputSimdWidth;
  92     constexpr IndexType OutputsPerChunk = ChunkSize / 8;
  93
  94     const auto inputVector = reinterpret_cast<const vec_t*>(input);
  95     IndexType count = 0;
  96     vec128_t base = vec128_zero;
  97     const vec128_t increment = vec128_set_16(8);
  98     for (IndexType i = 0; i < NumChunks; ++i)
  99     {
 100       // bitmask of nonzero values in this chunk
 101       unsigned nnz = 0;
 102       for (IndexType j = 0; j < InputsPerChunk; ++j)
 103       {
 104         const vec_t inputChunk = inputVector[i * InputsPerChunk + j];
 105         nnz |= (unsigned)vec_nnz(inputChunk) << (j * InputSimdWidth);
 106       }
 107       for (IndexType j = 0; j < OutputsPerChunk; ++j)
 108       {
 109         const auto lookup = (nnz >> (j * 8)) & 0xFF;
 110         const auto offsets = vec128_load(reinterpret_cast<const vec128_t*>(&lookup_indices[lookup]));
 111         vec128_storeu(reinterpret_cast<vec128_t*>(out + count), vec128_add(base, offsets));
 112         count += popcount(lookup);
 113         base = vec128_add(base, increment);
 114       }
 115     }
 116     count_out = count;
 117   }
 118 # undef vec_nnz
 119 # undef vec128_zero
 120 # undef vec128_set_16
 121 # undef vec128_load
 122 # undef vec128_storeu
 123 # undef vec128_add
 124 #endif
 125
 126   // Sparse input implementation
 127   template <IndexType InDims, IndexType OutDims>
 128   class AffineTransformSparseInput {
 129    public:
 130     // Input/output type
 131     using InputType = std::uint8_t;
 132     using OutputType = std::int32_t;
 133
 134     // Number of input/output dimensions
 135     static constexpr IndexType InputDimensions = InDims;
 136     static constexpr IndexType OutputDimensions = OutDims;
 137
 138     static_assert(OutputDimensions % 16 == 0, "Only implemented for OutputDimensions divisible by 16.");
 139
 140     static constexpr IndexType PaddedInputDimensions =
 141       ceil_to_multiple<IndexType>(InputDimensions, MaxSimdWidth);
 142     static constexpr IndexType PaddedOutputDimensions =
 143       ceil_to_multiple<IndexType>(OutputDimensions, MaxSimdWidth);
 144
 145 #if (USE_SSSE3 | (USE_NEON >= 8))
 146     static constexpr IndexType ChunkSize = 4;
 147 #else
 148     static constexpr IndexType ChunkSize = 1;
 149 #endif
 150
 151     using OutputBuffer = OutputType[PaddedOutputDimensions];
 152
 153     // Hash value embedded in the evaluation file
 154     static constexpr std::uint32_t get_hash_value(std::uint32_t prevHash) {
 155       std::uint32_t hashValue = 0xCC03DAE4u;
 156       hashValue += OutputDimensions;
 157       hashValue ^= prevHash >> 1;
 158       hashValue ^= prevHash << 31;
 159       return hashValue;
 160     }
 161
 162     static constexpr IndexType get_weight_index_scrambled(IndexType i)
 163     {
 164       return
 165         (i / ChunkSize) % (PaddedInputDimensions / ChunkSize) * OutputDimensions * ChunkSize +
 166         i / PaddedInputDimensions * ChunkSize +
 167         i % ChunkSize;
 168     }
 169
 170     static constexpr IndexType get_weight_index(IndexType i)
 171     {
 172 #if (USE_SSSE3 | (USE_NEON >= 8))
 173       return get_weight_index_scrambled(i);
 174 #else
 175       return i;
 176 #endif
 177     }
 178
 179     // Read network parameters
 180     bool read_parameters(std::istream& stream) {
 181       read_little_endian<BiasType>(stream, biases, OutputDimensions);
 182       for (IndexType i = 0; i < OutputDimensions * PaddedInputDimensions; ++i)
 183         weights[get_weight_index(i)] = read_little_endian<WeightType>(stream);
 184
 185       return !stream.fail();
 186     }
 187
 188     // Write network parameters
 189     bool write_parameters(std::ostream& stream) const {
 190       write_little_endian<BiasType>(stream, biases, OutputDimensions);
 191
 192       for (IndexType i = 0; i < OutputDimensions * PaddedInputDimensions; ++i)
 193         write_little_endian<WeightType>(stream, weights[get_weight_index(i)]);
 194
 195       return !stream.fail();
 196     }
 197     // Forward propagation
 198     void propagate(
 199         const InputType* input, OutputType* output) const {
 200
 201 #if (USE_SSSE3 | (USE_NEON >= 8))
 202 #if defined (USE_AVX512)
 203       using invec_t = __m512i;
 204       using outvec_t = __m512i;
 205       #define vec_set_32 _mm512_set1_epi32
 206       #define vec_add_dpbusd_32 Simd::m512_add_dpbusd_epi32
 207 #elif defined (USE_AVX2)
 208       using invec_t = __m256i;
 209       using outvec_t = __m256i;
 210       #define vec_set_32 _mm256_set1_epi32
 211       #define vec_add_dpbusd_32 Simd::m256_add_dpbusd_epi32
 212 #elif defined (USE_SSSE3)
 213       using invec_t = __m128i;
 214       using outvec_t = __m128i;
 215       #define vec_set_32 _mm_set1_epi32
 216       #define vec_add_dpbusd_32 Simd::m128_add_dpbusd_epi32
 217 #elif defined (USE_NEON_DOTPROD)
 218       using invec_t = int8x16_t;
 219       using outvec_t = int32x4_t;
 220       #define vec_set_32(a) vreinterpretq_s8_u32(vdupq_n_u32(a))
 221       #define vec_add_dpbusd_32 Simd::dotprod_m128_add_dpbusd_epi32
 222 #elif defined (USE_NEON)
 223       using invec_t = int8x16_t;
 224       using outvec_t = int32x4_t;
 225       #define vec_set_32(a) vreinterpretq_s8_u32(vdupq_n_u32(a))
 226       #define vec_add_dpbusd_32 Simd::neon_m128_add_dpbusd_epi32
 227 #endif
 228       static constexpr IndexType OutputSimdWidth = sizeof(outvec_t) / sizeof(OutputType);
 229
 230       constexpr IndexType NumChunks = ceil_to_multiple<IndexType>(InputDimensions, 8) / ChunkSize;
 231       constexpr IndexType NumRegs = OutputDimensions / OutputSimdWidth;
 232       std::uint16_t nnz[NumChunks];
 233       IndexType count;
 234
 235       const auto input32 = reinterpret_cast<const std::int32_t*>(input);
 236
 237       // Find indices of nonzero 32bit blocks
 238       find_nnz<NumChunks>(input32, nnz, count);
 239
 240       const outvec_t* biasvec = reinterpret_cast<const outvec_t*>(biases);
 241       outvec_t acc[NumRegs];
 242       for (IndexType k = 0; k < NumRegs; ++k)
 243         acc[k] = biasvec[k];
 244
 245       for (IndexType j = 0; j < count; ++j)
 246       {
 247         const auto i = nnz[j];
 248         const invec_t in = vec_set_32(input32[i]);
 249         const auto col = reinterpret_cast<const invec_t*>(&weights[i * OutputDimensions * ChunkSize]);
 250         for (IndexType k = 0; k < NumRegs; ++k)
 251           vec_add_dpbusd_32(acc[k], in, col[k]);
 252       }
 253
 254       outvec_t* outptr = reinterpret_cast<outvec_t*>(output);
 255       for (IndexType k = 0; k < NumRegs; ++k)
 256         outptr[k] = acc[k];
 257 # undef vec_set_32
 258 # undef vec_add_dpbusd_32
 259 #else
 260       // Use dense implementation for the other architectures.
 261       affine_transform_non_ssse3<
 262         InputDimensions,
 263         PaddedInputDimensions,
 264         OutputDimensions>(output, weights, biases, input);
 265 #endif
 266     }
 267
 268    private:
 269     using BiasType = OutputType;
 270     using WeightType = std::int8_t;
 271
 272     alignas(CacheLineSize) BiasType biases[OutputDimensions];
 273     alignas(CacheLineSize) WeightType weights[OutputDimensions * PaddedInputDimensions];
 274   };
 275
 276 }  // namespace Stockfish::Eval::NNUE::Layers
 277
 278 #endif // #ifndef NNUE_LAYERS_AFFINE_TRANSFORM_SPARSE_INPUT_H_INCLUDED