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