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