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