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