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