git.sesse.net Git - stockfish/blob - src/misc.cpp

   1 /*
   2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   3   Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
   4   Copyright (C) 2008-2015 Marco Costalba, Joona Kiiski, Tord Romstad
   5   Copyright (C) 2015-2017 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
   6
   7   Stockfish is free software: you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation, either version 3 of the License, or
  10   (at your option) any later version.
  11
  12   Stockfish is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #ifdef _WIN32
  22 #if _WIN32_WINNT < 0x0601
  23 #undef  _WIN32_WINNT
  24 #define _WIN32_WINNT 0x0601 // Force to include needed API prototypes
  25 #endif
  26 #include <windows.h>
  27 // The needed Windows API for processor groups could be missed from old Windows
  28 // versions, so instead of calling them directly (forcing the linker to resolve
  29 // the calls at compile time), try to load them at runtime. To do this we need
  30 // first to define the corresponding function pointers.
  31 extern "C" {
  32 typedef bool(*fun1_t)(LOGICAL_PROCESSOR_RELATIONSHIP,
  33                       PSYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX, PDWORD);
  34 typedef bool(*fun2_t)(USHORT, PGROUP_AFFINITY);
  35 typedef bool(*fun3_t)(HANDLE, CONST GROUP_AFFINITY*, PGROUP_AFFINITY);
  36 }
  37 #endif
  38
  39 #include <fstream>
  40 #include <iomanip>
  41 #include <iostream>
  42 #include <sstream>
  43 #include <vector>
  44
  45 #include "misc.h"
  46 #include "thread.h"
  47
  48 using namespace std;
  49
  50 namespace {
  51
  52 /// Version number. If Version is left empty, then compile date in the format
  53 /// DD-MM-YY and show in engine_info.
  54 const string Version = "";
  55
  56 /// Our fancy logging facility. The trick here is to replace cin.rdbuf() and
  57 /// cout.rdbuf() with two Tie objects that tie cin and cout to a file stream. We
  58 /// can toggle the logging of std::cout and std:cin at runtime whilst preserving
  59 /// usual I/O functionality, all without changing a single line of code!
  60 /// Idea from http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81
  61
  62 struct Tie: public streambuf { // MSVC requires split streambuf for cin and cout
  63
  64   Tie(streambuf* b, streambuf* l) : buf(b), logBuf(l) {}
  65
  66   int sync() { return logBuf->pubsync(), buf->pubsync(); }
  67   int overflow(int c) { return log(buf->sputc((char)c), "<< "); }
  68   int underflow() { return buf->sgetc(); }
  69   int uflow() { return log(buf->sbumpc(), ">> "); }
  70
  71   streambuf *buf, *logBuf;
  72
  73   int log(int c, const char* prefix) {
  74
  75     static int last = '\n'; // Single log file
  76
  77     if (last == '\n')
  78         logBuf->sputn(prefix, 3);
  79
  80     return last = logBuf->sputc((char)c);
  81   }
  82 };
  83
  84 class Logger {
  85
  86   Logger() : in(cin.rdbuf(), file.rdbuf()), out(cout.rdbuf(), file.rdbuf()) {}
  87  ~Logger() { start(""); }
  88
  89   ofstream file;
  90   Tie in, out;
  91
  92 public:
  93   static void start(const std::string& fname) {
  94
  95     static Logger l;
  96
  97     if (!fname.empty() && !l.file.is_open())
  98     {
  99         l.file.open(fname, ifstream::out);
 100         cin.rdbuf(&l.in);
 101         cout.rdbuf(&l.out);
 102     }
 103     else if (fname.empty() && l.file.is_open())
 104     {
 105         cout.rdbuf(l.out.buf);
 106         cin.rdbuf(l.in.buf);
 107         l.file.close();
 108     }
 109   }
 110 };
 111
 112 } // namespace
 113
 114 /// engine_info() returns the full name of the current Stockfish version. This
 115 /// will be either "Stockfish <Tag> DD-MM-YY" (where DD-MM-YY is the date when
 116 /// the program was compiled) or "Stockfish <Version>", depending on whether
 117 /// Version is empty.
 118
 119 const string engine_info(bool to_uci) {
 120
 121   const string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
 122   string month, day, year;
 123   stringstream ss, date(__DATE__); // From compiler, format is "Sep 21 2008"
 124
 125   ss << "Stockfish " << Version << setfill('0');
 126
 127   if (Version.empty())
 128   {
 129       date >> month >> day >> year;
 130       ss << setw(2) << day << setw(2) << (1 + months.find(month) / 4) << year.substr(2);
 131   }
 132
 133   ss << (Is64Bit ? " 64" : "")
 134      << (HasPext ? " BMI2" : (HasPopCnt ? " POPCNT" : ""))
 135      << (to_uci  ? "\nid author ": " by ")
 136      << "T. Romstad, M. Costalba, J. Kiiski, G. Linscott";
 137
 138   return ss.str();
 139 }
 140
 141
 142 /// Debug functions used mainly to collect run-time statistics
 143 static int64_t hits[2], means[2];
 144
 145 void dbg_hit_on(bool b) { ++hits[0]; if (b) ++hits[1]; }
 146 void dbg_hit_on(bool c, bool b) { if (c) dbg_hit_on(b); }
 147 void dbg_mean_of(int v) { ++means[0]; means[1] += v; }
 148
 149 void dbg_print() {
 150
 151   if (hits[0])
 152       cerr << "Total " << hits[0] << " Hits " << hits[1]
 153            << " hit rate (%) " << 100 * hits[1] / hits[0] << endl;
 154
 155   if (means[0])
 156       cerr << "Total " << means[0] << " Mean "
 157            << (double)means[1] / means[0] << endl;
 158 }
 159
 160
 161 /// Used to serialize access to std::cout to avoid multiple threads writing at
 162 /// the same time.
 163
 164 std::ostream& operator<<(std::ostream& os, SyncCout sc) {
 165
 166   static Mutex m;
 167
 168   if (sc == IO_LOCK)
 169       m.lock();
 170
 171   if (sc == IO_UNLOCK)
 172       m.unlock();
 173
 174   return os;
 175 }
 176
 177
 178 /// Trampoline helper to avoid moving Logger to misc.h
 179 void start_logger(const std::string& fname) { Logger::start(fname); }
 180
 181
 182 /// prefetch() preloads the given address in L1/L2 cache. This is a non-blocking
 183 /// function that doesn't stall the CPU waiting for data to be loaded from memory,
 184 /// which can be quite slow.
 185 #ifdef NO_PREFETCH
 186
 187 void prefetch(void*) {}
 188
 189 #else
 190
 191 void prefetch(void* addr) {
 192
 193 #  if defined(__INTEL_COMPILER)
 194    // This hack prevents prefetches from being optimized away by
 195    // Intel compiler. Both MSVC and gcc seem not be affected by this.
 196    __asm__ ("");
 197 #  endif
 198
 199 #  if defined(__INTEL_COMPILER) || defined(_MSC_VER)
 200   _mm_prefetch((char*)addr, _MM_HINT_T0);
 201 #  else
 202   __builtin_prefetch(addr);
 203 #  endif
 204 }
 205
 206 #endif
 207
 208 void prefetch2(void* addr) {
 209
 210   prefetch(addr);
 211   prefetch((uint8_t*)addr + 64);
 212 }
 213
 214 namespace WinProcGroup {
 215
 216 #ifndef _WIN32
 217
 218 void bindThisThread(size_t) {}
 219
 220 #else
 221
 222 /// get_group() retrieves logical processor information using Windows specific
 223 /// API and returns the best group id for the thread with index idx. Original
 224 /// code from Texel by Peter Österlund.
 225
 226 int get_group(size_t idx) {
 227
 228   int threads = 0;
 229   int nodes = 0;
 230   int cores = 0;
 231   DWORD returnLength = 0;
 232   DWORD byteOffset = 0;
 233
 234   // Early exit if the needed API is not available at runtime
 235   HMODULE k32 = GetModuleHandle("Kernel32.dll");
 236   auto fun1 = (fun1_t)GetProcAddress(k32, "GetLogicalProcessorInformationEx");
 237   if (!fun1)
 238       return -1;
 239
 240   // First call to get returnLength. We expect it to fail due to null buffer
 241   if (fun1(RelationAll, nullptr, &returnLength))
 242       return -1;
 243
 244   // Once we know returnLength, allocate the buffer
 245   SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX *buffer, *ptr;
 246   ptr = buffer = (SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX*)malloc(returnLength);
 247
 248   // Second call, now we expect to succeed
 249   if (!fun1(RelationAll, buffer, &returnLength))
 250   {
 251       free(buffer);
 252       return -1;
 253   }
 254
 255   while (ptr->Size > 0 && byteOffset + ptr->Size <= returnLength)
 256   {
 257       if (ptr->Relationship == RelationNumaNode)
 258           nodes++;
 259
 260       else if (ptr->Relationship == RelationProcessorCore)
 261       {
 262           cores++;
 263           threads += (ptr->Processor.Flags == LTP_PC_SMT) ? 2 : 1;
 264       }
 265
 266       byteOffset += ptr->Size;
 267       ptr = (SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX*)(((char*)ptr) + ptr->Size);
 268   }
 269
 270   free(buffer);
 271
 272   std::vector<int> groups;
 273
 274   // Run as many threads as possible on the same node until core limit is
 275   // reached, then move on filling the next node.
 276   for (int n = 0; n < nodes; n++)
 277       for (int i = 0; i < cores / nodes; i++)
 278           groups.push_back(n);
 279
 280   // In case a core has more than one logical processor (we assume 2) and we
 281   // have still threads to allocate, then spread them evenly across available
 282   // nodes.
 283   for (int t = 0; t < threads - cores; t++)
 284       groups.push_back(t % nodes);
 285
 286   // If we still have more threads than the total number of logical processors
 287   // then return -1 and let the OS to decide what to do.
 288   return idx < groups.size() ? groups[idx] : -1;
 289 }
 290
 291
 292 /// bindThisThread() set the group affinity of the current thread
 293
 294 void bindThisThread(size_t idx) {
 295
 296   // If OS already scheduled us on a different group than 0 then don't overwrite
 297   // the choice, eventually we are one of many one-threaded processes running on
 298   // some Windows NUMA hardware, for instance in fishtest. To make it simple,
 299   // just check if running threads are below a threshold, in this case all this
 300   // NUMA machinery is not needed.
 301   if (Threads.size() < 8)
 302       return;
 303
 304   // Use only local variables to be thread-safe
 305   int group = get_group(idx);
 306
 307   if (group == -1)
 308       return;
 309
 310   // Early exit if the needed API are not available at runtime
 311   HMODULE k32 = GetModuleHandle("Kernel32.dll");
 312   auto fun2 = (fun2_t)GetProcAddress(k32, "GetNumaNodeProcessorMaskEx");
 313   auto fun3 = (fun3_t)GetProcAddress(k32, "SetThreadGroupAffinity");
 314
 315   if (!fun2 || !fun3)
 316       return;
 317
 318   GROUP_AFFINITY affinity;
 319   if (fun2(group, &affinity))
 320       fun3(GetCurrentThread(), &affinity, nullptr);
 321 }
 322
 323 #endif
 324
 325 } // namespace WinProcGroup