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