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