ecc3008a6cc8a728927011ba4b6154a232e76994
[stockfish] / 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             __m512i product = _mm512_maddubs_epi16(
108               _mm512_load_si512(&input_vector[j]), _mm512_load_si512(&row[j]));
109             product = _mm512_madd_epi16(product, kOnes);
110             sum = _mm512_add_epi32(sum, product);
111         }
112         output[i] = _mm512_reduce_add_epi32(sum) + biases_[i];
113
114         // Note: Changing kMaxSimdWidth from 32 to 64 breaks loading existing networks.
115         // As a result kPaddedInputDimensions may not be an even multiple of 64(512bit)
116         // and we have to do one more 256bit chunk.
117         if (kPaddedInputDimensions != kNumChunks * kSimdWidth * 2)
118         {
119             const auto iv_256  = reinterpret_cast<const __m256i*>(input);
120             const auto row_256 = reinterpret_cast<const __m256i*>(&weights_[offset]);
121             int j = kNumChunks * 2;
122
123             __m256i sum256 = _mm256_maddubs_epi16(
124               _mm256_load_si256(&iv_256[j]), _mm256_load_si256(&row_256[j]));
125             sum256 = _mm256_madd_epi16(sum256, _mm256_set1_epi16(1));
126             sum256 = _mm256_hadd_epi32(sum256, sum256);
127             sum256 = _mm256_hadd_epi32(sum256, sum256);
128             const __m128i lo = _mm256_extracti128_si256(sum256, 0);
129             const __m128i hi = _mm256_extracti128_si256(sum256, 1);
130             output[i] += _mm_cvtsi128_si32(lo) + _mm_cvtsi128_si32(hi);
131         }
132
133   #elif defined(USE_AVX2)
134         __m256i sum = _mm256_setzero_si256();
135         const auto row = reinterpret_cast<const __m256i*>(&weights_[offset]);
136         for (IndexType j = 0; j < kNumChunks; ++j) {
137           __m256i product = _mm256_maddubs_epi16(
138             _mm256_load_si256(&input_vector[j]), _mm256_load_si256(&row[j]));
139           product = _mm256_madd_epi16(product, kOnes);
140           sum = _mm256_add_epi32(sum, product);
141         }
142         sum = _mm256_hadd_epi32(sum, sum);
143         sum = _mm256_hadd_epi32(sum, sum);
144         const __m128i lo = _mm256_extracti128_si256(sum, 0);
145         const __m128i hi = _mm256_extracti128_si256(sum, 1);
146         output[i] = _mm_cvtsi128_si32(lo) + _mm_cvtsi128_si32(hi) + biases_[i];
147
148   #elif defined(USE_SSSE3)
149         __m128i sum = _mm_cvtsi32_si128(biases_[i]);
150         const auto row = reinterpret_cast<const __m128i*>(&weights_[offset]);
151         for (IndexType j = 0; j < kNumChunks; ++j) {
152           __m128i product = _mm_maddubs_epi16(
153               _mm_load_si128(&input_vector[j]), _mm_load_si128(&row[j]));
154           product = _mm_madd_epi16(product, kOnes);
155           sum = _mm_add_epi32(sum, product);
156         }
157         sum = _mm_hadd_epi32(sum, sum);
158         sum = _mm_hadd_epi32(sum, sum);
159         output[i] = _mm_cvtsi128_si32(sum);
160
161   #elif defined(USE_NEON)
162         int32x4_t sum = {biases_[i]};
163         const auto row = reinterpret_cast<const int8x8_t*>(&weights_[offset]);
164         for (IndexType j = 0; j < kNumChunks; ++j) {
165           int16x8_t product = vmull_s8(input_vector[j * 2], row[j * 2]);
166           product = vmlal_s8(product, input_vector[j * 2 + 1], row[j * 2 + 1]);
167           sum = vpadalq_s16(sum, product);
168         }
169         output[i] = sum[0] + sum[1] + sum[2] + sum[3];
170
171   #else
172         OutputType sum = biases_[i];
173         for (IndexType j = 0; j < kInputDimensions; ++j) {
174           sum += weights_[offset + j] * input[j];
175         }
176         output[i] = sum;
177   #endif
178
179       }
180       return output;
181     }
182
183    private:
184     using BiasType = OutputType;
185     using WeightType = std::int8_t;
186
187     PreviousLayer previous_layer_;
188
189     alignas(kCacheLineSize) BiasType biases_[kOutputDimensions];
190     alignas(kCacheLineSize)
191         WeightType weights_[kOutputDimensions * kPaddedInputDimensions];
192   };
193
194 }  // namespace Eval::NNUE::Layers
195
196 #endif // #ifndef NNUE_LAYERS_AFFINE_TRANSFORM_H_INCLUDED