]> git.sesse.net Git - stockfish/blobdiff - src/misc.cpp
Avoid spamming the GUI in multipv search
[stockfish] / src / misc.cpp
index c692e996f2ce2fa292e287119c4a9699086aacc4..608d772501fc54c70967d16e55ed80ba9cccb573 100644 (file)
@@ -1,7 +1,7 @@
 /*
   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
-  Copyright (C) 2008-2009 Marco Costalba
+  Copyright (C) 2008-2012 Marco Costalba, Joona Kiiski, Tord Romstad
 
   Stockfish is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-
-////
-//// Includes
-////
-
-#if !defined(_MSC_VER)
-
-#  include <sys/time.h>
-#  include <sys/types.h>
-#  include <unistd.h>
-
-#else
-
-#define _CRT_SECURE_NO_DEPRECATE
-#include <windows.h>
-#include <sys/timeb.h>
-
-#endif
-
-#include <cassert>
-#include <cstdio>
 #include <iomanip>
 #include <iostream>
 #include <sstream>
 
-#include "bitcount.h"
 #include "misc.h"
+#include "thread.h"
+
+#if defined(__hpux)
+#    include <sys/pstat.h>
+#endif
 
 using namespace std;
 
-/// Version number. If this is left empty, the current date (in the format
-/// YYMMDD) is used as a version number.
+/// Version number. If Version is left empty, then Tag plus current
+/// date (in the format YYMMDD) is used as a version number.
+
+static const string Version = "";
+static const string Tag = "";
 
-static const string EngineVersion = "";
-static const string AppName = "Stockfish";
-static const string AppTag  = "";
 
+/// engine_info() returns the full name of the current Stockfish version.
+/// This will be either "Stockfish YYMMDD" (where YYMMDD is the date when
+/// the program was compiled) or "Stockfish <version number>", depending
+/// on whether Version is empty.
 
-////
-//// Variables
-////
+const string engine_info(bool to_uci) {
 
-bool Chess960;
+  const string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
+  const string cpu64(Is64Bit ? " 64bit" : "");
+  const string popcnt(HasPopCnt ? " SSE4.2" : "");
 
-uint64_t dbg_cnt0 = 0;
-uint64_t dbg_cnt1 = 0;
+  string month, day, year;
+  stringstream s, date(__DATE__); // From compiler, format is "Sep 21 2008"
 
-bool dbg_show_mean = false;
-bool dbg_show_hit_rate = false;
+  s << "Stockfish " << Version;
 
+  if (Version.empty())
+  {
+      date >> month >> day >> year;
 
-////
-//// Functions
-////
+      s << Tag << setfill('0') << " " << year.substr(2)
+        << setw(2) << (1 + months.find(month) / 4) << setw(2) << day;
+  }
 
-void dbg_hit_on(bool b) {
+  s << cpu64 << popcnt << (to_uci ? "\nid author ": " by ")
+    << "Tord Romstad, Marco Costalba and Joona Kiiski";
 
-    assert(!dbg_show_mean);
-    dbg_show_hit_rate = true;
-    dbg_cnt0++;
-    if (b)
-        dbg_cnt1++;
+  return s.str();
 }
 
-void dbg_hit_on_c(bool c, bool b) {
 
-    if (c)
-        dbg_hit_on(b);
+/// Convert system time to milliseconds. That's all we need.
+
+Time::point Time::now() {
+  sys_time_t t; system_time(&t); return time_to_msec(t);
 }
 
-void dbg_before() {
 
-    assert(!dbg_show_mean);
-    dbg_show_hit_rate = true;
-    dbg_cnt0++;
-}
+/// Debug functions used mainly to collect run-time statistics
 
-void dbg_after() {
+static uint64_t hits[2], means[2];
 
-    assert(!dbg_show_mean);
-    dbg_show_hit_rate = true;
-    dbg_cnt1++;
-}
+void dbg_hit_on(bool b) { hits[0]++; if (b) hits[1]++; }
+void dbg_hit_on_c(bool c, bool b) { if (c) dbg_hit_on(b); }
+void dbg_mean_of(int v) { means[0]++; means[1] += v; }
 
-void dbg_mean_of(int v) {
+void dbg_print() {
 
-    assert(!dbg_show_hit_rate);
-    dbg_show_mean = true;
-    dbg_cnt0++;
-    dbg_cnt1 += v;
+  if (hits[0])
+      cerr << "Total " << hits[0] << " Hits " << hits[1]
+           << " hit rate (%) " << 100 * hits[1] / hits[0] << endl;
+
+  if (means[0])
+      cerr << "Total " << means[0] << " Mean "
+           << (float)means[1] / means[0] << endl;
 }
 
-void dbg_print_hit_rate() {
 
-  cout << "Total " << dbg_cnt0 << " Hit " << dbg_cnt1
-       << " hit rate (%) " << (dbg_cnt1*100)/(dbg_cnt0 ? dbg_cnt0 : 1) << endl;
-}
+/// Our fancy logging facility. The trick here is to replace cin.rdbuf() and
+/// cout.rdbuf() with two Tie objects that tie cin and cout to a file stream. We
+/// can toggle the logging of std::cout and std:cin at runtime while preserving
+/// usual i/o functionality and without changing a single line of code!
+/// Idea from http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81
 
-void dbg_print_mean() {
+struct Tie: public streambuf { // MSVC requires splitted streambuf for cin and cout
 
-  cout << "Total " << dbg_cnt0 << " Mean "
-       << (float)dbg_cnt1 / (dbg_cnt0 ? dbg_cnt0 : 1) << endl;
-}
+  Tie(streambuf* b, ofstream* f) : buf(b), file(f) {}
 
-void dbg_print_hit_rate(ofstream& logFile) {
+  int sync() { return file->rdbuf()->pubsync(), buf->pubsync(); }
+  int overflow(int c) { return log(buf->sputc((char)c), "<< "); }
+  int underflow() { return buf->sgetc(); }
+  int uflow() { return log(buf->sbumpc(), ">> "); }
 
-  logFile << "Total " << dbg_cnt0 << " Hit " << dbg_cnt1
-          << " hit rate (%) " << (dbg_cnt1*100)/(dbg_cnt0 ? dbg_cnt0 : 1) << endl;
-}
+  streambuf* buf;
+  ofstream* file;
 
-void dbg_print_mean(ofstream& logFile) {
+  int log(int c, const char* prefix) {
 
-  logFile << "Total " << dbg_cnt0 << " Mean "
-          << (float)dbg_cnt1 / (dbg_cnt0 ? dbg_cnt0 : 1) << endl;
-}
+    static int last = '\n';
 
-/// engine_name() returns the full name of the current Stockfish version.
-/// This will be either "Stockfish YYMMDD" (where YYMMDD is the date when the
-/// program was compiled) or "Stockfish <version number>", depending on whether
-/// the constant EngineVersion (defined in misc.h) is empty.
+    if (last == '\n')
+        file->rdbuf()->sputn(prefix, 3);
 
-const string engine_name() {
+    return last = file->rdbuf()->sputc((char)c);
+  }
+};
 
-  const string cpu64(CpuHas64BitPath ? " 64bit" : "");
+class Logger {
 
-  if (!EngineVersion.empty())
-      return AppName+ " " + EngineVersion + cpu64;
+  Logger() : in(cin.rdbuf(), &file), out(cout.rdbuf(), &file) {}
+ ~Logger() { start(false); }
 
-  string date(__DATE__); // From compiler, format is "Sep 21 2008"
-  string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
+  ofstream file;
+  Tie in, out;
 
-  size_t mon = 1 + months.find(date.substr(0, 3)) / 4;
+public:
+  static void start(bool b) {
 
-  stringstream s;
-  string day = (date[4] == ' ' ? date.substr(5, 1) : date.substr(4, 2));
+    static Logger l;
 
-  string name = AppName + " " + AppTag + " ";
+    if (b && !l.file.is_open())
+    {
+        l.file.open("io_log.txt", ifstream::out | ifstream::app);
+        cin.rdbuf(&l.in);
+        cout.rdbuf(&l.out);
+    }
+    else if (!b && l.file.is_open())
+    {
+        cout.rdbuf(l.out.buf);
+        cin.rdbuf(l.in.buf);
+        l.file.close();
+    }
+  }
+};
 
-  s << name << date.substr(date.length() - 2) << setfill('0')
-    << setw(2) << mon << setw(2) << day << cpu64;
 
-  return s.str();
-}
+/// Used to serialize access to std::cout to avoid multiple threads to write at
+/// the same time.
 
+std::ostream& operator<<(std::ostream& os, SyncCout sc) {
 
-/// get_system_time() returns the current system time, measured in
-/// milliseconds.
+  static Mutex m;
 
-int get_system_time() {
+  if (sc == io_lock)
+      m.lock();
 
-#if defined(_MSC_VER)
-    struct _timeb t;
-    _ftime(&t);
-    return int(t.time*1000 + t.millitm);
-#else
-    struct timeval t;
-    gettimeofday(&t, NULL);
-    return t.tv_sec*1000 + t.tv_usec/1000;
-#endif
+  if (sc == io_unlock)
+      m.unlock();
+
+  return os;
 }
 
 
-/// cpu_count() tries to detect the number of CPU cores.
+/// Trampoline helper to avoid moving Logger to misc.h
+void start_logger(bool b) { Logger::start(b); }
 
-#if !defined(_MSC_VER)
 
-#  if defined(_SC_NPROCESSORS_ONLN)
+/// cpu_count() tries to detect the number of CPU cores
+
 int cpu_count() {
-  return Min(sysconf(_SC_NPROCESSORS_ONLN), 8);
-}
+
+#if defined(_WIN32) || defined(_WIN64)
+  SYSTEM_INFO s;
+  GetSystemInfo(&s);
+  return s.dwNumberOfProcessors;
+#else
+
+#  if defined(_SC_NPROCESSORS_ONLN)
+  return sysconf(_SC_NPROCESSORS_ONLN);
+#  elif defined(__hpux)
+  struct pst_dynamic psd;
+  if (pstat_getdynamic(&psd, sizeof(psd), (size_t)1, 0) == -1)
+      return 1;
+  return psd.psd_proc_cnt;
 #  else
-int cpu_count() {
   return 1;
-}
 #  endif
 
+#endif
+}
+
+
+/// timed_wait() waits for msec milliseconds. It is mainly an helper to wrap
+/// conversion from milliseconds to struct timespec, as used by pthreads.
+
+void timed_wait(WaitCondition& sleepCond, Lock& sleepLock, int msec) {
+
+#if defined(_WIN32) || defined(_WIN64)
+  int tm = msec;
 #else
+  timespec ts, *tm = &ts;
+  uint64_t ms = Time::now() + msec;
 
-int cpu_count() {
-  SYSTEM_INFO s;
-  GetSystemInfo(&s);
-  return Min(s.dwNumberOfProcessors, 8);
+  ts.tv_sec = ms / 1000;
+  ts.tv_nsec = (ms % 1000) * 1000000LL;
+#endif
+
+  cond_timedwait(sleepCond, sleepLock, tm);
 }
 
-#endif
 
+/// prefetch() preloads the given address in L1/L2 cache. This is a non
+/// blocking function and do not stalls the CPU waiting for data to be
+/// loaded from memory, that can be quite slow.
+#if defined(NO_PREFETCH)
 
-/*
-  From Beowulf, from Olithink
-*/
-#ifndef _WIN32
-/* Non-windows version */
-int Bioskey()
-{
-  fd_set          readfds;
-  struct timeval  timeout;
-
-  FD_ZERO(&readfds);
-  FD_SET(fileno(stdin), &readfds);
-  /* Set to timeout immediately */
-  timeout.tv_sec = 0;
-  timeout.tv_usec = 0;
-  select(16, &readfds, 0, 0, &timeout);
-
-  return (FD_ISSET(fileno(stdin), &readfds));
-}
+void prefetch(char*) {}
 
 #else
-/* Windows-version */
-#include <windows.h>
-#include <conio.h>
-int Bioskey()
-{
-    static int      init = 0,
-                    pipe;
-    static HANDLE   inh;
-    DWORD           dw;
-    /* If we're running under XBoard then we can't use _kbhit() as the input
-     * commands are sent to us directly over the internal pipe */
-
-#if defined(FILE_CNT)
-    if (stdin->_cnt > 0)
-        return stdin->_cnt;
-#endif
-    if (!init) {
-        init = 1;
-        inh = GetStdHandle(STD_INPUT_HANDLE);
-        pipe = !GetConsoleMode(inh, &dw);
-        if (!pipe) {
-            SetConsoleMode(inh, dw & ~(ENABLE_MOUSE_INPUT | ENABLE_WINDOW_INPUT));
-            FlushConsoleInputBuffer(inh);
-        }
-    }
-    if (pipe) {
-        if (!PeekNamedPipe(inh, NULL, 0, NULL, &dw, NULL))
-            return 1;
-        return dw;
-    } else {
-        // Count the number of unread input records, including keyboard,
-        // mouse, and window-resizing input records.
-        GetNumberOfConsoleInputEvents(inh, &dw);
-        if (dw <= 0)
-            return 0;
-
-        // Read data from console without removing it from the buffer
-        INPUT_RECORD rec[256];
-        DWORD recCnt;
-        if (!PeekConsoleInput(inh, rec, Min(dw, 256), &recCnt))
-            return 0;
-
-        // Search for at least one keyboard event
-        for (DWORD i = 0; i < recCnt; i++)
-            if (rec[i].EventType == KEY_EVENT)
-                return 1;
-
-        return 0;
-    }
+
+void prefetch(char* addr) {
+
+#  if defined(__INTEL_COMPILER)
+   // This hack prevents prefetches to be optimized away by
+   // Intel compiler. Both MSVC and gcc seems not affected.
+   __asm__ ("");
+#  endif
+
+#  if defined(__INTEL_COMPILER) || defined(_MSC_VER)
+  _mm_prefetch(addr, _MM_HINT_T0);
+  _mm_prefetch(addr+64, _MM_HINT_T0); // 64 bytes ahead
+#  else
+  __builtin_prefetch(addr);
+  __builtin_prefetch(addr+64);
+#  endif
 }
+
 #endif