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-2012 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(_WIN32) || defined(_WIN64)
  21
  22 #define NOMINMAX // disable macros min() and max()
  23 #include <windows.h>
  24
  25 #else
  26
  27 #  include <unistd.h>
  28 #  if defined(__hpux)
  29 #     include <sys/pstat.h>
  30 #  endif
  31
  32 #endif
  33
  34 #if !defined(NO_PREFETCH)
  35 #  include <xmmintrin.h>
  36 #endif
  37
  38 #include <algorithm>
  39 #include <iomanip>
  40 #include <iostream>
  41 #include <sstream>
  42 #include <streambuf>
  43
  44 #include "misc.h"
  45 #include "thread.h"
  46
  47 using namespace std;
  48
  49 /// Version number. If Version is left empty, then Tag plus current
  50 /// date (in the format YYMMDD) is used as a version number.
  51
  52 static const string Version = "";
  53 static const string Tag = "";
  54
  55
  56 /// engine_info() returns the full name of the current Stockfish version.
  57 /// This will be either "Stockfish YYMMDD" (where YYMMDD is the date when
  58 /// the program was compiled) or "Stockfish <version number>", depending
  59 /// on whether Version is empty.
  60
  61 const string engine_info(bool to_uci) {
  62
  63   const string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
  64   const string cpu64(Is64Bit ? " 64bit" : "");
  65   const string popcnt(HasPopCnt ? " SSE4.2" : "");
  66
  67   string month, day, year;
  68   stringstream s, date(__DATE__); // From compiler, format is "Sep 21 2008"
  69
  70   if (Version.empty())
  71   {
  72       date >> month >> day >> year;
  73
  74       s << "Stockfish " << Tag
  75         << setfill('0') << " " << year.substr(2)
  76         << setw(2) << (1 + months.find(month) / 4)
  77         << setw(2) << day;
  78   }
  79   else
  80       s << "Stockfish " << Version;
  81
  82   s << cpu64 << popcnt << (to_uci ? "\nid author ": " by ")
  83     << "Tord Romstad, Marco Costalba and Joona Kiiski";
  84
  85   return s.str();
  86 }
  87
  88
  89 /// Debug functions used mainly to collect run-time statistics
  90
  91 static uint64_t hits[2], means[2];
  92
  93 void dbg_hit_on(bool b) { hits[0]++; if (b) hits[1]++; }
  94 void dbg_hit_on_c(bool c, bool b) { if (c) dbg_hit_on(b); }
  95 void dbg_mean_of(int v) { means[0]++; means[1] += v; }
  96
  97 void dbg_print() {
  98
  99   if (hits[0])
 100       cerr << "Total " << hits[0] << " Hits " << hits[1]
 101            << " hit rate (%) " << 100 * hits[1] / hits[0] << endl;
 102
 103   if (means[0])
 104       cerr << "Total " << means[0] << " Mean "
 105            << (float)means[1] / means[0] << endl;
 106 }
 107
 108
 109 /// Our fancy logging facility. The trick here is to replace cout.rdbuf() with
 110 /// this one that sends the output both to console and to a file, this allow us
 111 /// to toggle the logging of std::cout to a file while preserving output to
 112 /// stdout and without changing a single line of code! Idea and code from:
 113 /// http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81
 114
 115 class Logger: public streambuf {
 116 public:
 117   typedef char_traits<char> traits_type;
 118   typedef traits_type::int_type int_type;
 119
 120   Logger() : cout_buf(cout.rdbuf()) {}
 121   ~Logger() { set(false); }
 122
 123   void set(bool b) {
 124
 125     if (b && !file.is_open())
 126     {
 127         file.open("out.txt", ifstream::out | ifstream::app);
 128         cout.rdbuf(this);
 129     }
 130     else if (!b && file.is_open())
 131     {
 132         cout.rdbuf(cout_buf);
 133         file.close();
 134     }
 135   }
 136
 137 private:
 138   int_type overflow(int_type c) {
 139
 140     if (traits_type::eq_int_type(c, traits_type::eof()))
 141         return traits_type::not_eof(c);
 142
 143     c = cout_buf->sputc(traits_type::to_char_type(c));
 144
 145     if (!traits_type::eq_int_type(c, traits_type::eof()))
 146         c = file.rdbuf()->sputc(traits_type::to_char_type(c));
 147
 148     return c;
 149   }
 150
 151   int sync() {
 152
 153     int c = cout_buf->pubsync();
 154
 155     if (c != -1)
 156         c = file.rdbuf()->pubsync();
 157
 158     return c;
 159   }
 160
 161   ofstream file;
 162   streambuf* cout_buf;
 163 };
 164
 165 void logger_set(bool b) {
 166
 167   static Logger l;
 168   l.set(b);
 169 }
 170
 171
 172 /// cpu_count() tries to detect the number of CPU cores
 173
 174 int cpu_count() {
 175
 176 #if defined(_WIN32) || defined(_WIN64)
 177   SYSTEM_INFO s;
 178   GetSystemInfo(&s);
 179   return std::min(int(s.dwNumberOfProcessors), MAX_THREADS);
 180 #else
 181
 182 #  if defined(_SC_NPROCESSORS_ONLN)
 183   return std::min((int)sysconf(_SC_NPROCESSORS_ONLN), MAX_THREADS);
 184 #  elif defined(__hpux)
 185   struct pst_dynamic psd;
 186   if (pstat_getdynamic(&psd, sizeof(psd), (size_t)1, 0) == -1)
 187       return 1;
 188   return std::min((int)psd.psd_proc_cnt, MAX_THREADS);
 189 #  else
 190   return 1;
 191 #  endif
 192
 193 #endif
 194 }
 195
 196
 197 /// timed_wait() waits for msec milliseconds. It is mainly an helper to wrap
 198 /// conversion from milliseconds to struct timespec, as used by pthreads.
 199
 200 void timed_wait(WaitCondition& sleepCond, Lock& sleepLock, int msec) {
 201
 202 #if defined(_WIN32) || defined(_WIN64)
 203   int tm = msec;
 204 #else
 205   timespec ts, *tm = &ts;
 206   uint64_t ms = Time::current_time().msec() + msec;
 207
 208   ts.tv_sec = ms / 1000;
 209   ts.tv_nsec = (ms % 1000) * 1000000LL;
 210 #endif
 211
 212   cond_timedwait(sleepCond, sleepLock, tm);
 213 }
 214
 215
 216 /// prefetch() preloads the given address in L1/L2 cache. This is a non
 217 /// blocking function and do not stalls the CPU waiting for data to be
 218 /// loaded from memory, that can be quite slow.
 219 #if defined(NO_PREFETCH)
 220
 221 void prefetch(char*) {}
 222
 223 #else
 224
 225 void prefetch(char* addr) {
 226
 227 #  if defined(__INTEL_COMPILER) || defined(__ICL)
 228    // This hack prevents prefetches to be optimized away by
 229    // Intel compiler. Both MSVC and gcc seems not affected.
 230    __asm__ ("");
 231 #  endif
 232
 233   _mm_prefetch(addr, _MM_HINT_T2);
 234   _mm_prefetch(addr+64, _MM_HINT_T2); // 64 bytes ahead
 235 }
 236
 237 #endif