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