ff33cc7974b12d616d6f6f49c3dcbcaa5d252e5e
[stockfish] / src / nnue / nnue_common.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 // Constants used in NNUE evaluation function
20
21 #ifndef NNUE_COMMON_H_INCLUDED
22 #define NNUE_COMMON_H_INCLUDED
23
24 #if defined(USE_AVX2)
25 #include <immintrin.h>
26
27 #elif defined(USE_SSE41)
28 #include <smmintrin.h>
29
30 #elif defined(USE_SSSE3)
31 #include <tmmintrin.h>
32
33 #elif defined(USE_SSE2)
34 #include <emmintrin.h>
35
36 #elif defined(USE_NEON)
37 #include <arm_neon.h>
38 #endif
39
40 // HACK: Use _mm256_loadu_si256() instead of _mm256_load_si256. Otherwise a binary
41 //       compiled with older g++ crashes because the output memory is not aligned
42 //       even though alignas is specified.
43 #if defined(USE_AVX2)
44 #if defined(__GNUC__ ) && (__GNUC__ < 9)
45 #define _mm256_loadA_si256  _mm256_loadu_si256
46 #define _mm256_storeA_si256 _mm256_storeu_si256
47 #else
48 #define _mm256_loadA_si256  _mm256_load_si256
49 #define _mm256_storeA_si256 _mm256_store_si256
50 #endif
51 #endif
52
53 #if defined(USE_AVX512)
54 #if defined(__GNUC__ ) && (__GNUC__ < 9)
55 #define _mm512_loadA_si512   _mm512_loadu_si512
56 #define _mm512_storeA_si512  _mm512_storeu_si512
57 #else
58 #define _mm512_loadA_si512   _mm512_load_si512
59 #define _mm512_storeA_si512  _mm512_store_si512
60 #endif
61 #endif
62
63 namespace Eval::NNUE {
64
65   // Version of the evaluation file
66   constexpr std::uint32_t kVersion = 0x7AF32F16u;
67
68   // Constant used in evaluation value calculation
69   constexpr int FV_SCALE = 16;
70   constexpr int kWeightScaleBits = 6;
71
72   // Size of cache line (in bytes)
73   constexpr std::size_t kCacheLineSize = 64;
74
75   // SIMD width (in bytes)
76   #if defined(USE_AVX2)
77   constexpr std::size_t kSimdWidth = 32;
78
79   #elif defined(USE_SSE2)
80   constexpr std::size_t kSimdWidth = 16;
81
82   #elif defined(USE_NEON)
83   constexpr std::size_t kSimdWidth = 16;
84   #endif
85
86   constexpr std::size_t kMaxSimdWidth = 32;
87
88   // Type of input feature after conversion
89   using TransformedFeatureType = std::uint8_t;
90   using IndexType = std::uint32_t;
91
92   // Round n up to be a multiple of base
93   template <typename IntType>
94   constexpr IntType CeilToMultiple(IntType n, IntType base) {
95     return (n + base - 1) / base * base;
96   }
97
98 }  // namespace Eval::NNUE
99
100 #endif // #ifndef NNUE_COMMON_H_INCLUDED