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

   1 /*
   2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   3   Copyright (C) 2004-2021 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 #include <cstring>
  25 #include <iostream>
  26
  27 #if defined(USE_AVX2)
  28 #include <immintrin.h>
  29
  30 #elif defined(USE_SSE41)
  31 #include <smmintrin.h>
  32
  33 #elif defined(USE_SSSE3)
  34 #include <tmmintrin.h>
  35
  36 #elif defined(USE_SSE2)
  37 #include <emmintrin.h>
  38
  39 #elif defined(USE_MMX)
  40 #include <mmintrin.h>
  41
  42 #elif defined(USE_NEON)
  43 #include <arm_neon.h>
  44 #endif
  45
  46 namespace Stockfish::Eval::NNUE {
  47
  48   // Version of the evaluation file
  49   constexpr std::uint32_t Version = 0x7AF32F20u;
  50
  51   // Constant used in evaluation value calculation
  52   constexpr int OutputScale = 16;
  53   constexpr int WeightScaleBits = 6;
  54
  55   // Size of cache line (in bytes)
  56   constexpr std::size_t CacheLineSize = 64;
  57
  58   // SIMD width (in bytes)
  59   #if defined(USE_AVX2)
  60   constexpr std::size_t SimdWidth = 32;
  61
  62   #elif defined(USE_SSE2)
  63   constexpr std::size_t SimdWidth = 16;
  64
  65   #elif defined(USE_MMX)
  66   constexpr std::size_t SimdWidth = 8;
  67
  68   #elif defined(USE_NEON)
  69   constexpr std::size_t SimdWidth = 16;
  70   #endif
  71
  72   constexpr std::size_t MaxSimdWidth = 32;
  73
  74   // Type of input feature after conversion
  75   using TransformedFeatureType = std::uint8_t;
  76   using IndexType = std::uint32_t;
  77
  78   // Round n up to be a multiple of base
  79   template <typename IntType>
  80   constexpr IntType ceil_to_multiple(IntType n, IntType base) {
  81       return (n + base - 1) / base * base;
  82   }
  83
  84   // read_little_endian() is our utility to read an integer (signed or unsigned, any size)
  85   // from a stream in little-endian order. We swap the byte order after the read if
  86   // necessary to return a result with the byte ordering of the compiling machine.
  87   template <typename IntType>
  88   inline IntType read_little_endian(std::istream& stream) {
  89
  90       IntType result;
  91       std::uint8_t u[sizeof(IntType)];
  92       typename std::make_unsigned<IntType>::type v = 0;
  93
  94       stream.read(reinterpret_cast<char*>(u), sizeof(IntType));
  95       for (std::size_t i = 0; i < sizeof(IntType); ++i)
  96           v = (v << 8) | u[sizeof(IntType) - i - 1];
  97
  98       std::memcpy(&result, &v, sizeof(IntType));
  99       return result;
 100   }
 101
 102   template <typename IntType>
 103   inline void write_little_endian(std::ostream& stream, IntType value) {
 104
 105       std::uint8_t u[sizeof(IntType)];
 106       typename std::make_unsigned<IntType>::type v = value;
 107
 108       std::size_t i = 0;
 109       // if constexpr to silence the warning about shift by 8
 110       if constexpr (sizeof(IntType) > 1) {
 111         for (; i + 1 < sizeof(IntType); ++i) {
 112             u[i] = v;
 113             v >>= 8;
 114         }
 115       }
 116       u[i] = v;
 117
 118       stream.write(reinterpret_cast<char*>(u), sizeof(IntType));
 119   }
 120 }  // namespace Stockfish::Eval::NNUE
 121
 122 #endif // #ifndef NNUE_COMMON_H_INCLUDED