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

   1 /*
   2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   3   Copyright (C) 2004-2020 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 AffineTransform of NNUE evaluation function
  20
  21 #ifndef NNUE_LAYERS_AFFINE_TRANSFORM_H_INCLUDED
  22 #define NNUE_LAYERS_AFFINE_TRANSFORM_H_INCLUDED
  23
  24 #include <iostream>
  25 #include "../nnue_common.h"
  26
  27 namespace Eval::NNUE::Layers {
  28
  29   // Affine transformation layer
  30   template <typename PreviousLayer, IndexType OutputDimensions>
  31   class AffineTransform {
  32    public:
  33     // Input/output type
  34     using InputType = typename PreviousLayer::OutputType;
  35     using OutputType = std::int32_t;
  36     static_assert(std::is_same<InputType, std::uint8_t>::value, "");
  37
  38     // Number of input/output dimensions
  39     static constexpr IndexType kInputDimensions =
  40         PreviousLayer::kOutputDimensions;
  41     static constexpr IndexType kOutputDimensions = OutputDimensions;
  42     static constexpr IndexType kPaddedInputDimensions =
  43         CeilToMultiple<IndexType>(kInputDimensions, kMaxSimdWidth);
  44
  45     // Size of forward propagation buffer used in this layer
  46     static constexpr std::size_t kSelfBufferSize =
  47         CeilToMultiple(kOutputDimensions * sizeof(OutputType), kCacheLineSize);
  48
  49     // Size of the forward propagation buffer used from the input layer to this layer
  50     static constexpr std::size_t kBufferSize =
  51         PreviousLayer::kBufferSize + kSelfBufferSize;
  52
  53     // Hash value embedded in the evaluation file
  54     static constexpr std::uint32_t GetHashValue() {
  55       std::uint32_t hash_value = 0xCC03DAE4u;
  56       hash_value += kOutputDimensions;
  57       hash_value ^= PreviousLayer::GetHashValue() >> 1;
  58       hash_value ^= PreviousLayer::GetHashValue() << 31;
  59       return hash_value;
  60     }
  61
  62    // Read network parameters
  63     bool ReadParameters(std::istream& stream) {
  64       if (!previous_layer_.ReadParameters(stream)) return false;
  65       stream.read(reinterpret_cast<char*>(biases_),
  66                   kOutputDimensions * sizeof(BiasType));
  67       stream.read(reinterpret_cast<char*>(weights_),
  68                   kOutputDimensions * kPaddedInputDimensions *
  69                   sizeof(WeightType));
  70       return !stream.fail();
  71     }
  72
  73     // Forward propagation
  74     const OutputType* Propagate(
  75         const TransformedFeatureType* transformed_features, char* buffer) const {
  76       const auto input = previous_layer_.Propagate(
  77           transformed_features, buffer + kSelfBufferSize);
  78       const auto output = reinterpret_cast<OutputType*>(buffer);
  79
  80   #if defined(USE_AVX512)
  81       constexpr IndexType kNumChunks = kPaddedInputDimensions / (kSimdWidth * 2);
  82       const __m512i kOnes = _mm512_set1_epi16(1);
  83       const auto input_vector = reinterpret_cast<const __m512i*>(input);
  84
  85   #elif defined(USE_AVX2)
  86       constexpr IndexType kNumChunks = kPaddedInputDimensions / kSimdWidth;
  87       const __m256i kOnes = _mm256_set1_epi16(1);
  88       const auto input_vector = reinterpret_cast<const __m256i*>(input);
  89
  90   #elif defined(USE_SSSE3)
  91       constexpr IndexType kNumChunks = kPaddedInputDimensions / kSimdWidth;
  92       const __m128i kOnes = _mm_set1_epi16(1);
  93       const auto input_vector = reinterpret_cast<const __m128i*>(input);
  94
  95   #elif defined(USE_NEON)
  96       constexpr IndexType kNumChunks = kPaddedInputDimensions / kSimdWidth;
  97       const auto input_vector = reinterpret_cast<const int8x8_t*>(input);
  98   #endif
  99
 100       for (IndexType i = 0; i < kOutputDimensions; ++i) {
 101         const IndexType offset = i * kPaddedInputDimensions;
 102
 103   #if defined(USE_AVX512)
 104         __m512i sum = _mm512_setzero_si512();
 105         const auto row = reinterpret_cast<const __m512i*>(&weights_[offset]);
 106         for (IndexType j = 0; j < kNumChunks; ++j) {
 107
 108   #if defined(__MINGW32__) || defined(__MINGW64__)
 109             __m512i product = _mm512_maddubs_epi16(_mm512_loadu_si512(&input_vector[j]), _mm512_load_si512(&row[j]));
 110   #else
 111             __m512i product = _mm512_maddubs_epi16(_mm512_load_si512(&input_vector[j]), _mm512_load_si512(&row[j]));
 112   #endif
 113
 114             product = _mm512_madd_epi16(product, kOnes);
 115             sum = _mm512_add_epi32(sum, product);
 116         }
 117         output[i] = _mm512_reduce_add_epi32(sum) + biases_[i];
 118
 119         // Note: Changing kMaxSimdWidth from 32 to 64 breaks loading existing networks.
 120         // As a result kPaddedInputDimensions may not be an even multiple of 64(512bit)
 121         // and we have to do one more 256bit chunk.
 122         if (kPaddedInputDimensions != kNumChunks * kSimdWidth * 2)
 123         {
 124             const auto iv_256  = reinterpret_cast<const __m256i*>(input);
 125             const auto row_256 = reinterpret_cast<const __m256i*>(&weights_[offset]);
 126             int j = kNumChunks * 2;
 127
 128   #if defined(__MINGW32__) || defined(__MINGW64__)  // See HACK comment below in AVX2.
 129             __m256i sum256 = _mm256_maddubs_epi16(_mm256_loadu_si256(&iv_256[j]), _mm256_load_si256(&row_256[j]));
 130   #else
 131             __m256i sum256 = _mm256_maddubs_epi16(_mm256_load_si256(&iv_256[j]), _mm256_load_si256(&row_256[j]));
 132   #endif
 133
 134             sum256 = _mm256_madd_epi16(sum256, _mm256_set1_epi16(1));
 135             sum256 = _mm256_hadd_epi32(sum256, sum256);
 136             sum256 = _mm256_hadd_epi32(sum256, sum256);
 137             const __m128i lo = _mm256_extracti128_si256(sum256, 0);
 138             const __m128i hi = _mm256_extracti128_si256(sum256, 1);
 139             output[i] += _mm_cvtsi128_si32(lo) + _mm_cvtsi128_si32(hi);
 140         }
 141
 142   #elif defined(USE_AVX2)
 143         __m256i sum = _mm256_setzero_si256();
 144         const auto row = reinterpret_cast<const __m256i*>(&weights_[offset]);
 145         for (IndexType j = 0; j < kNumChunks; ++j) {
 146           __m256i product = _mm256_maddubs_epi16(
 147
 148   #if defined(__MINGW32__) || defined(__MINGW64__)
 149             // HACK: Use _mm256_loadu_si256() instead of _mm256_load_si256. Because the binary
 150             //       compiled with g++ in MSYS2 crashes here because the output memory is not aligned
 151             //       even though alignas is specified.
 152             _mm256_loadu_si256
 153   #else
 154             _mm256_load_si256
 155   #endif
 156
 157             (&input_vector[j]), _mm256_load_si256(&row[j]));
 158           product = _mm256_madd_epi16(product, kOnes);
 159           sum = _mm256_add_epi32(sum, product);
 160         }
 161         sum = _mm256_hadd_epi32(sum, sum);
 162         sum = _mm256_hadd_epi32(sum, sum);
 163         const __m128i lo = _mm256_extracti128_si256(sum, 0);
 164         const __m128i hi = _mm256_extracti128_si256(sum, 1);
 165         output[i] = _mm_cvtsi128_si32(lo) + _mm_cvtsi128_si32(hi) + biases_[i];
 166
 167   #elif defined(USE_SSSE3)
 168         __m128i sum = _mm_cvtsi32_si128(biases_[i]);
 169         const auto row = reinterpret_cast<const __m128i*>(&weights_[offset]);
 170         for (IndexType j = 0; j < kNumChunks; ++j) {
 171           __m128i product = _mm_maddubs_epi16(
 172               _mm_load_si128(&input_vector[j]), _mm_load_si128(&row[j]));
 173           product = _mm_madd_epi16(product, kOnes);
 174           sum = _mm_add_epi32(sum, product);
 175         }
 176         sum = _mm_hadd_epi32(sum, sum);
 177         sum = _mm_hadd_epi32(sum, sum);
 178         output[i] = _mm_cvtsi128_si32(sum);
 179
 180   #elif defined(USE_NEON)
 181         int32x4_t sum = {biases_[i]};
 182         const auto row = reinterpret_cast<const int8x8_t*>(&weights_[offset]);
 183         for (IndexType j = 0; j < kNumChunks; ++j) {
 184           int16x8_t product = vmull_s8(input_vector[j * 2], row[j * 2]);
 185           product = vmlal_s8(product, input_vector[j * 2 + 1], row[j * 2 + 1]);
 186           sum = vpadalq_s16(sum, product);
 187         }
 188         output[i] = sum[0] + sum[1] + sum[2] + sum[3];
 189
 190   #else
 191         OutputType sum = biases_[i];
 192         for (IndexType j = 0; j < kInputDimensions; ++j) {
 193           sum += weights_[offset + j] * input[j];
 194         }
 195         output[i] = sum;
 196   #endif
 197
 198       }
 199       return output;
 200     }
 201
 202    private:
 203     using BiasType = OutputType;
 204     using WeightType = std::int8_t;
 205
 206     PreviousLayer previous_layer_;
 207
 208     alignas(kCacheLineSize) BiasType biases_[kOutputDimensions];
 209     alignas(kCacheLineSize)
 210         WeightType weights_[kOutputDimensions * kPaddedInputDimensions];
 211   };
 212
 213 }  // namespace Eval::NNUE::Layers
 214
 215 #endif // #ifndef NNUE_LAYERS_AFFINE_TRANSFORM_H_INCLUDED