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-2010 Marco Costalba, Joona Kiiski, Tord Romstad
   5
   6   Stockfish is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   Stockfish is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #if !defined(_MSC_VER)
  21
  22 #  include <sys/time.h>
  23 #  include <sys/types.h>
  24 #  include <unistd.h>
  25 #  if defined(__hpux)
  26 #     include <sys/pstat.h>
  27 #  endif
  28
  29 #else
  30
  31 #define _CRT_SECURE_NO_DEPRECATE
  32 #define NOMINMAX // disable macros min() and max()
  33 #include <windows.h>
  34 #include <sys/timeb.h>
  35
  36 #endif
  37
  38 #if !defined(NO_PREFETCH)
  39 #  include <xmmintrin.h>
  40 #endif
  41
  42 #include <cassert>
  43 #include <cstdio>
  44 #include <iomanip>
  45 #include <iostream>
  46 #include <sstream>
  47 #include <algorithm>
  48
  49 #include "bitcount.h"
  50 #include "misc.h"
  51 #include "thread.h"
  52
  53 using namespace std;
  54
  55 /// Version number. If EngineVersion is left empty, then AppTag plus
  56 /// current date (in the format YYMMDD) is used as a version number.
  57
  58 static const string AppName = "Stockfish";
  59 static const string EngineVersion = "";
  60 static const string AppTag  = "";
  61
  62
  63 /// engine_name() returns the full name of the current Stockfish version.
  64 /// This will be either "Stockfish YYMMDD" (where YYMMDD is the date when
  65 /// the program was compiled) or "Stockfish <version number>", depending
  66 /// on whether the constant EngineVersion is empty.
  67
  68 const string engine_name() {
  69
  70   const string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
  71   const string cpu64(CpuIs64Bit ? " 64bit" : "");
  72
  73   if (!EngineVersion.empty())
  74       return AppName + " " + EngineVersion + cpu64;
  75
  76   stringstream s, date(__DATE__); // From compiler, format is "Sep 21 2008"
  77   string month, day, year;
  78
  79   date >> month >> day >> year;
  80
  81   s << setfill('0') << AppName + " " + AppTag + " "
  82     << year.substr(2, 2) << setw(2)
  83     << (1 + months.find(month) / 4) << setw(2)
  84     << day << cpu64;
  85
  86   return s.str();
  87 }
  88
  89
  90 /// Our brave developers! Required by UCI
  91
  92 const string engine_authors() {
  93
  94   return "Tord Romstad, Marco Costalba and Joona Kiiski";
  95 }
  96
  97
  98 /// Debug stuff. Helper functions used mainly for debugging purposes
  99
 100 static uint64_t dbg_hit_cnt0;
 101 static uint64_t dbg_hit_cnt1;
 102 static uint64_t dbg_mean_cnt0;
 103 static uint64_t dbg_mean_cnt1;
 104
 105 void dbg_print_hit_rate() {
 106
 107   if (dbg_hit_cnt0)
 108       cerr << "Total " << dbg_hit_cnt0 << " Hit " << dbg_hit_cnt1
 109            << " hit rate (%) " << 100 * dbg_hit_cnt1 / dbg_hit_cnt0 << endl;
 110 }
 111
 112 void dbg_print_mean() {
 113
 114   if (dbg_mean_cnt0)
 115       cerr << "Total " << dbg_mean_cnt0 << " Mean "
 116            << (float)dbg_mean_cnt1 / dbg_mean_cnt0 << endl;
 117 }
 118
 119 void dbg_mean_of(int v) {
 120
 121   dbg_mean_cnt0++;
 122   dbg_mean_cnt1 += v;
 123 }
 124
 125 void dbg_hit_on(bool b) {
 126
 127   dbg_hit_cnt0++;
 128   if (b)
 129       dbg_hit_cnt1++;
 130 }
 131
 132 void dbg_hit_on_c(bool c, bool b) { if (c) dbg_hit_on(b); }
 133 void dbg_before() { dbg_hit_on(false); }
 134 void dbg_after()  { dbg_hit_on(true); dbg_hit_cnt0--; }
 135
 136
 137 /// get_system_time() returns the current system time, measured in milliseconds
 138
 139 int get_system_time() {
 140
 141 #if defined(_MSC_VER)
 142   struct _timeb t;
 143   _ftime(&t);
 144   return int(t.time * 1000 + t.millitm);
 145 #else
 146   struct timeval t;
 147   gettimeofday(&t, NULL);
 148   return t.tv_sec * 1000 + t.tv_usec / 1000;
 149 #endif
 150 }
 151
 152
 153 /// cpu_count() tries to detect the number of CPU cores
 154
 155 int cpu_count() {
 156
 157 #if defined(_MSC_VER)
 158   SYSTEM_INFO s;
 159   GetSystemInfo(&s);
 160   return std::min(int(s.dwNumberOfProcessors), MAX_THREADS);
 161 #else
 162
 163 #  if defined(_SC_NPROCESSORS_ONLN)
 164   return std::min((int)sysconf(_SC_NPROCESSORS_ONLN), MAX_THREADS);
 165 #  elif defined(__hpux)
 166   struct pst_dynamic psd;
 167   if (pstat_getdynamic(&psd, sizeof(psd), (size_t)1, 0) == -1)
 168       return 1;
 169   return std::min((int)psd.psd_proc_cnt, MAX_THREADS);
 170 #  else
 171   return 1;
 172 #  endif
 173
 174 #endif
 175 }
 176
 177
 178 /// Check for console input. Original code from Beowulf, Olithink and Greko
 179
 180 #ifndef _WIN32
 181
 182 int input_available() {
 183
 184   fd_set readfds;
 185   struct timeval  timeout;
 186
 187   FD_ZERO(&readfds);
 188   FD_SET(fileno(stdin), &readfds);
 189   timeout.tv_sec = 0; // Set to timeout immediately
 190   timeout.tv_usec = 0;
 191   select(16, &readfds, 0, 0, &timeout);
 192
 193   return (FD_ISSET(fileno(stdin), &readfds));
 194 }
 195
 196 #else
 197
 198 int input_available() {
 199
 200   static HANDLE inh = NULL;
 201   static bool usePipe = false;
 202   INPUT_RECORD rec[256];
 203   DWORD nchars, recCnt;
 204
 205   if (!inh)
 206   {
 207       inh = GetStdHandle(STD_INPUT_HANDLE);
 208       if (GetConsoleMode(inh, &nchars))
 209       {
 210           SetConsoleMode(inh, nchars & ~(ENABLE_MOUSE_INPUT | ENABLE_WINDOW_INPUT));
 211           FlushConsoleInputBuffer(inh);
 212       } else
 213           usePipe = true;
 214   }
 215
 216   // When using Standard C input functions, also check if there
 217   // is anything in the buffer. After a call to such functions,
 218   // the input waiting in the pipe will be copied to the buffer,
 219   // and the call to PeekNamedPipe can indicate no input available.
 220   // Setting stdin to unbuffered was not enough. [from Greko]
 221   if (stdin->_cnt > 0)
 222       return 1;
 223
 224   // When running under a GUI the input commands are sent to us
 225   // directly over the internal pipe. If PeekNamedPipe() returns 0
 226   // then something went wrong. Probably the parent program exited.
 227   // Returning 1 will make the next call to the input function
 228   // return EOF, where this should be catched then.
 229   if (usePipe)
 230       return PeekNamedPipe(inh, NULL, 0, NULL, &nchars, NULL) ? nchars : 1;
 231
 232   // Count the number of unread input records, including keyboard,
 233   // mouse, and window-resizing input records.
 234   GetNumberOfConsoleInputEvents(inh, &nchars);
 235
 236   // Read data from console without removing it from the buffer
 237   if (nchars <= 0 || !PeekConsoleInput(inh, rec, std::min(int(nchars), 256), &recCnt))
 238       return 0;
 239
 240   // Search for at least one keyboard event
 241   for (DWORD i = 0; i < recCnt; i++)
 242       if (rec[i].EventType == KEY_EVENT)
 243           return 1;
 244
 245   return 0;
 246 }
 247
 248 #endif
 249
 250
 251 /// prefetch() preloads the given address in L1/L2 cache. This is a non
 252 /// blocking function and do not stalls the CPU waiting for data to be
 253 /// loaded from memory, that can be quite slow.
 254 #if defined(NO_PREFETCH)
 255
 256 void prefetch(char*) {}
 257
 258 #else
 259
 260 void prefetch(char* addr) {
 261
 262 #if defined(__INTEL_COMPILER) || defined(__ICL)
 263    // This hack prevents prefetches to be optimized away by
 264    // Intel compiler. Both MSVC and gcc seems not affected.
 265    __asm__ ("");
 266 #endif
 267
 268   _mm_prefetch(addr, _MM_HINT_T2);
 269   _mm_prefetch(addr+64, _MM_HINT_T2); // 64 bytes ahead
 270 }
 271
 272 #endif