]> git.sesse.net Git - stockfish/blobdiff - src/misc.cpp
Add (smart) logging facility
[stockfish] / src / misc.cpp
index d53836438aa716a6eb38c3c95401b9cdf1d09ca3..125115a4cd57f8dc33724291b49014f0ce014b56 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-2010 Marco Costalba, Joona Kiiski, Tord Romstad
+  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/>.
 */
 
-#if !defined(_MSC_VER)
+#if defined(_WIN32) || defined(_WIN64)
+
+#define NOMINMAX // disable macros min() and max()
+#include <windows.h>
+
+#else
 
-#  include <sys/time.h>
-#  include <sys/types.h>
 #  include <unistd.h>
 #  if defined(__hpux)
 #     include <sys/pstat.h>
 #  endif
 
-#else
-
-#define _CRT_SECURE_NO_DEPRECATE
-#include <windows.h>
-#include <sys/timeb.h>
-
 #endif
 
 #if !defined(NO_PREFETCH)
 #  include <xmmintrin.h>
 #endif
 
-#include <cassert>
-#include <cstdio>
+#include <algorithm>
 #include <iomanip>
 #include <iostream>
 #include <sstream>
+#include <streambuf>
 
-#include "bitcount.h"
 #include "misc.h"
 #include "thread.h"
 
 using namespace std;
 
-/// Version number. If EngineVersion is left empty, then AppTag plus
-/// 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 AppName = "Stockfish";
-static const string EngineVersion = "";
-static const string AppTag  = "";
+static const string Version = "";
+static const string Tag = "";
 
 
-/// engine_name() returns the full name of the current Stockfish version.
+/// 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 the constant EngineVersion is empty.
+/// on whether Version is empty.
 
-const string engine_name() {
+const string engine_info(bool to_uci) {
 
   const string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
-  const string cpu64(CpuIs64Bit ? " 64bit" : "");
-
-  if (!EngineVersion.empty())
-      return AppName + " " + EngineVersion + cpu64;
+  const string cpu64(Is64Bit ? " 64bit" : "");
+  const string popcnt(HasPopCnt ? " SSE4.2" : "");
 
-  stringstream s, date(__DATE__); // From compiler, format is "Sep 21 2008"
   string month, day, year;
+  stringstream s, date(__DATE__); // From compiler, format is "Sep 21 2008"
+
+  if (Version.empty())
+  {
+      date >> month >> day >> year;
 
-  date >> month >> day >> year;
+      s << "Stockfish " << Tag
+        << setfill('0') << " " << year.substr(2)
+        << setw(2) << (1 + months.find(month) / 4)
+        << setw(2) << day;
+  }
+  else
+      s << "Stockfish " << Version;
 
-  s << setfill('0') << AppName + " " + AppTag + " "
-    << year.substr(2, 2) << setw(2)
-    << (1 + months.find(month) / 4) << setw(2)
-    << day << cpu64;
+  s << cpu64 << popcnt << (to_uci ? "\nid author ": " by ")
+    << "Tord Romstad, Marco Costalba and Joona Kiiski";
 
   return s.str();
 }
 
 
-/// Our brave developers! Required by UCI
+/// Debug functions used mainly to collect run-time statistics
 
-const string engine_authors() {
+static uint64_t hits[2], means[2];
 
-  return "Tord Romstad, Marco Costalba and Joona Kiiski";
-}
+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_print() {
 
-/// Debug stuff. Helper functions used mainly for debugging purposes
+  if (hits[0])
+      cerr << "Total " << hits[0] << " Hits " << hits[1]
+           << " hit rate (%) " << 100 * hits[1] / hits[0] << endl;
 
-static uint64_t dbg_hit_cnt0;
-static uint64_t dbg_hit_cnt1;
-static uint64_t dbg_mean_cnt0;
-static uint64_t dbg_mean_cnt1;
+  if (means[0])
+      cerr << "Total " << means[0] << " Mean "
+           << (float)means[1] / means[0] << endl;
+}
 
-void dbg_print_hit_rate() {
 
-  if (dbg_hit_cnt0)
-      cerr << "Total " << dbg_hit_cnt0 << " Hit " << dbg_hit_cnt1
-           << " hit rate (%) " << 100 * dbg_hit_cnt1 / dbg_hit_cnt0 << endl;
-}
+/// Our fancy logging facility. The trick here is to replace cout.rdbuf() with
+/// this one that sends the output both to console and to a file, this allow us
+/// to toggle the logging of std::cout to a file while preserving output to
+/// stdout and without changing a single line of code! Idea and code from:
+/// http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81
+
+class Logger: public streambuf {
+public:
+  typedef char_traits<char> traits_type;
+  typedef traits_type::int_type int_type;
+
+  Logger() : cout_buf(cout.rdbuf()) {}
+  ~Logger() { set(false); }
+
+  void set(bool b) {
+
+    if (b && !file.is_open())
+    {
+        file.open("out.txt", ifstream::out | ifstream::app);
+        cout.rdbuf(this);
+    }
+    else if (!b && file.is_open())
+    {
+        cout.rdbuf(cout_buf);
+        file.close();
+    }
+  }
 
-void dbg_print_mean() {
+private:
+  int_type overflow(int_type c) {
 
-  if (dbg_mean_cnt0)
-      cerr << "Total " << dbg_mean_cnt0 << " Mean "
-           << (float)dbg_mean_cnt1 / dbg_mean_cnt0 << endl;
-}
+    if (traits_type::eq_int_type(c, traits_type::eof()))
+        return traits_type::not_eof(c);
 
-void dbg_mean_of(int v) {
+    c = cout_buf->sputc(traits_type::to_char_type(c));
 
-  dbg_mean_cnt0++;
-  dbg_mean_cnt1 += v;
-}
+    if (!traits_type::eq_int_type(c, traits_type::eof()))
+        c = file.rdbuf()->sputc(traits_type::to_char_type(c));
 
-void dbg_hit_on(bool b) {
+    return c;
+  }
 
-  dbg_hit_cnt0++;
-  if (b)
-      dbg_hit_cnt1++;
-}
+  int sync() {
 
-void dbg_hit_on_c(bool c, bool b) { if (c) dbg_hit_on(b); }
-void dbg_before() { dbg_hit_on(false); }
-void dbg_after()  { dbg_hit_on(true); dbg_hit_cnt0--; }
+    int c = cout_buf->pubsync();
 
+    if (c != -1)
+        c = file.rdbuf()->pubsync();
 
-/// get_system_time() returns the current system time, measured in milliseconds
+    return c;
+  }
 
-int get_system_time() {
+  ofstream file;
+  streambuf* cout_buf;
+};
 
-#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
+void logger_set(bool b) {
+
+  static Logger l;
+  l.set(b);
 }
 
 
@@ -152,19 +173,19 @@ int get_system_time() {
 
 int cpu_count() {
 
-#if defined(_MSC_VER)
+#if defined(_WIN32) || defined(_WIN64)
   SYSTEM_INFO s;
   GetSystemInfo(&s);
-  return Min(s.dwNumberOfProcessors, MAX_THREADS);
+  return std::min(int(s.dwNumberOfProcessors), MAX_THREADS);
 #else
 
 #  if defined(_SC_NPROCESSORS_ONLN)
-  return Min(sysconf(_SC_NPROCESSORS_ONLN), MAX_THREADS);
+  return std::min((int)sysconf(_SC_NPROCESSORS_ONLN), MAX_THREADS);
 #  elif defined(__hpux)
   struct pst_dynamic psd;
   if (pstat_getdynamic(&psd, sizeof(psd), (size_t)1, 0) == -1)
       return 1;
-  return Min(psd.psd_proc_cnt, MAX_THREADS);
+  return std::min((int)psd.psd_proc_cnt, MAX_THREADS);
 #  else
   return 1;
 #  endif
@@ -173,78 +194,24 @@ int cpu_count() {
 }
 
 
-/// Check for console input. Original code from Beowulf, Olithink and Greko
-
-#ifndef _WIN32
-
-int input_available() {
+/// timed_wait() waits for msec milliseconds. It is mainly an helper to wrap
+/// conversion from milliseconds to struct timespec, as used by pthreads.
 
-  fd_set readfds;
-  struct timeval  timeout;
-
-  FD_ZERO(&readfds);
-  FD_SET(fileno(stdin), &readfds);
-  timeout.tv_sec = 0; // Set to timeout immediately
-  timeout.tv_usec = 0;
-  select(16, &readfds, 0, 0, &timeout);
-
-  return (FD_ISSET(fileno(stdin), &readfds));
-}
+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::current_time().msec() + msec;
 
-int input_available() {
-
-  static HANDLE inh = NULL;
-  static bool usePipe = false;
-  INPUT_RECORD rec[256];
-  DWORD nchars, recCnt;
-
-  if (!inh)
-  {
-      inh = GetStdHandle(STD_INPUT_HANDLE);
-      if (GetConsoleMode(inh, &nchars))
-      {
-          SetConsoleMode(inh, nchars & ~(ENABLE_MOUSE_INPUT | ENABLE_WINDOW_INPUT));
-          FlushConsoleInputBuffer(inh);
-      } else
-          usePipe = true;
-  }
-
-  // When using Standard C input functions, also check if there
-  // is anything in the buffer. After a call to such functions,
-  // the input waiting in the pipe will be copied to the buffer,
-  // and the call to PeekNamedPipe can indicate no input available.
-  // Setting stdin to unbuffered was not enough. [from Greko]
-  if (stdin->_cnt > 0)
-      return 1;
-
-  // When running under a GUI the input commands are sent to us
-  // directly over the internal pipe. If PeekNamedPipe() returns 0
-  // then something went wrong. Probably the parent program exited.
-  // Returning 1 will make the next call to the input function
-  // return EOF, where this should be catched then.
-  if (usePipe)
-      return PeekNamedPipe(inh, NULL, 0, NULL, &nchars, NULL) ? nchars : 1;
-
-  // Count the number of unread input records, including keyboard,
-  // mouse, and window-resizing input records.
-  GetNumberOfConsoleInputEvents(inh, &nchars);
-
-  // Read data from console without removing it from the buffer
-  if (nchars <= 0 || !PeekConsoleInput(inh, rec, Min(nchars, 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;
+  ts.tv_sec = ms / 1000;
+  ts.tv_nsec = (ms % 1000) * 1000000LL;
+#endif
 
-  return 0;
+  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
@@ -257,11 +224,11 @@ void prefetch(char*) {}
 
 void prefetch(char* addr) {
 
-#if defined(__INTEL_COMPILER) || defined(__ICL)
+#  if defined(__INTEL_COMPILER) || defined(__ICL)
    // This hack prevents prefetches to be optimized away by
    // Intel compiler. Both MSVC and gcc seems not affected.
    __asm__ ("");
-#endif
+#  endif
 
   _mm_prefetch(addr, _MM_HINT_T2);
   _mm_prefetch(addr+64, _MM_HINT_T2); // 64 bytes ahead