]> git.sesse.net Git - stockfish/blobdiff - src/misc.cpp
Rename getters functions removing 'get_' prefix
[stockfish] / src / misc.cpp
index c692e996f2ce2fa292e287119c4a9699086aacc4..5912514c23dbadaf63133281c130497fe3a63a72 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-2010 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)
 
-////
-//// Includes
-////
+#define _CRT_SECURE_NO_DEPRECATE
+#define NOMINMAX // disable macros min() and max()
+#include <windows.h>
+#include <sys/timeb.h>
 
-#if !defined(_MSC_VER)
+#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 <iomanip>
 #include <iostream>
 #include <sstream>
+#include <algorithm>
 
 #include "bitcount.h"
 #include "misc.h"
+#include "thread.h"
 
 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 EngineVersion is left empty, then AppTag plus
+/// current date (in the format YYMMDD) is used as a version number.
 
-static const string EngineVersion = "";
 static const string AppName = "Stockfish";
+static const string EngineVersion = "";
 static const string AppTag  = "";
 
 
-////
-//// Variables
-////
+/// 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 is empty.
 
-bool Chess960;
+const string engine_name() {
 
-uint64_t dbg_cnt0 = 0;
-uint64_t dbg_cnt1 = 0;
+  const string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
+  const string cpu64(CpuIs64Bit ? " 64bit" : "");
 
-bool dbg_show_mean = false;
-bool dbg_show_hit_rate = false;
+  if (!EngineVersion.empty())
+      return AppName + " " + EngineVersion + cpu64;
 
+  stringstream s, date(__DATE__); // From compiler, format is "Sep 21 2008"
+  string month, day, year;
 
-////
-//// Functions
-////
+  date >> month >> day >> year;
 
-void dbg_hit_on(bool b) {
+  s << setfill('0') << AppName + " " + AppTag + " "
+    << year.substr(2, 2) << setw(2)
+    << (1 + months.find(month) / 4) << setw(2)
+    << day << cpu64;
 
-    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);
-}
+/// Our brave developers! Required by UCI
 
-void dbg_before() {
+const string engine_authors() {
 
-    assert(!dbg_show_mean);
-    dbg_show_hit_rate = true;
-    dbg_cnt0++;
+  return "Tord Romstad, Marco Costalba and Joona Kiiski";
 }
 
-void dbg_after() {
 
-    assert(!dbg_show_mean);
-    dbg_show_hit_rate = true;
-    dbg_cnt1++;
-}
+/// Debug stuff. Helper functions used mainly for debugging purposes
 
-void dbg_mean_of(int v) {
-
-    assert(!dbg_show_hit_rate);
-    dbg_show_mean = true;
-    dbg_cnt0++;
-    dbg_cnt1 += v;
-}
+static uint64_t dbg_hit_cnt0;
+static uint64_t dbg_hit_cnt1;
+static uint64_t dbg_mean_cnt0;
+static uint64_t dbg_mean_cnt1;
 
 void dbg_print_hit_rate() {
 
-  cout << "Total " << dbg_cnt0 << " Hit " << dbg_cnt1
-       << " hit rate (%) " << (dbg_cnt1*100)/(dbg_cnt0 ? dbg_cnt0 : 1) << endl;
+  if (dbg_hit_cnt0)
+      cerr << "Total " << dbg_hit_cnt0 << " Hit " << dbg_hit_cnt1
+           << " hit rate (%) " << 100 * dbg_hit_cnt1 / dbg_hit_cnt0 << endl;
 }
 
 void dbg_print_mean() {
 
-  cout << "Total " << dbg_cnt0 << " Mean "
-       << (float)dbg_cnt1 / (dbg_cnt0 ? dbg_cnt0 : 1) << endl;
+  if (dbg_mean_cnt0)
+      cerr << "Total " << dbg_mean_cnt0 << " Mean "
+           << (float)dbg_mean_cnt1 / dbg_mean_cnt0 << endl;
 }
 
-void dbg_print_hit_rate(ofstream& logFile) {
+void dbg_mean_of(int v) {
 
-  logFile << "Total " << dbg_cnt0 << " Hit " << dbg_cnt1
-          << " hit rate (%) " << (dbg_cnt1*100)/(dbg_cnt0 ? dbg_cnt0 : 1) << endl;
+  dbg_mean_cnt0++;
+  dbg_mean_cnt1 += v;
 }
 
-void dbg_print_mean(ofstream& logFile) {
+void dbg_hit_on(bool b) {
 
-  logFile << "Total " << dbg_cnt0 << " Mean "
-          << (float)dbg_cnt1 / (dbg_cnt0 ? dbg_cnt0 : 1) << endl;
+  dbg_hit_cnt0++;
+  if (b)
+      dbg_hit_cnt1++;
 }
 
-/// 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.
+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--; }
 
-const string engine_name() {
 
-  const string cpu64(CpuHas64BitPath ? " 64bit" : "");
+/// system_time() returns the current system time, measured in milliseconds
 
-  if (!EngineVersion.empty())
-      return AppName+ " " + EngineVersion + cpu64;
+int system_time() {
 
-  string date(__DATE__); // From compiler, format is "Sep 21 2008"
-  string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
+#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
+}
 
-  size_t mon = 1 + months.find(date.substr(0, 3)) / 4;
 
-  stringstream s;
-  string day = (date[4] == ' ' ? date.substr(5, 1) : date.substr(4, 2));
+/// cpu_count() tries to detect the number of CPU cores
 
-  string name = AppName + " " + AppTag + " ";
+int cpu_count() {
 
-  s << name << date.substr(date.length() - 2) << setfill('0')
-    << setw(2) << mon << setw(2) << day << cpu64;
+#if defined(_MSC_VER)
+  SYSTEM_INFO s;
+  GetSystemInfo(&s);
+  return std::min(int(s.dwNumberOfProcessors), MAX_THREADS);
+#else
 
-  return s.str();
+#  if defined(_SC_NPROCESSORS_ONLN)
+  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 std::min((int)psd.psd_proc_cnt, MAX_THREADS);
+#  else
+  return 1;
+#  endif
+
+#endif
 }
 
 
-/// get_system_time() returns the current system time, measured in
-/// milliseconds.
+/// timed_wait() waits for msec milliseconds. It is mainly an helper to wrap
+/// conversion from milliseconds to struct timespec, as used by pthreads.
 
-int get_system_time() {
+void timed_wait(WaitCondition* sleepCond, Lock* sleepLock, int msec) {
 
 #if defined(_MSC_VER)
-    struct _timeb t;
-    _ftime(&t);
-    return int(t.time*1000 + t.millitm);
+  int tm = msec;
 #else
-    struct timeval t;
-    gettimeofday(&t, NULL);
-    return t.tv_sec*1000 + t.tv_usec/1000;
-#endif
-}
+  struct timeval t;
+  struct timespec abstime, *tm = &abstime;
 
+  gettimeofday(&t, NULL);
 
-/// cpu_count() tries to detect the number of CPU cores.
+  abstime.tv_sec = t.tv_sec + (msec / 1000);
+  abstime.tv_nsec = (t.tv_usec + (msec % 1000) * 1000) * 1000;
 
-#if !defined(_MSC_VER)
+  if (abstime.tv_nsec > 1000000000LL)
+  {
+      abstime.tv_sec += 1;
+      abstime.tv_nsec -= 1000000000LL;
+  }
+#endif
 
-#  if defined(_SC_NPROCESSORS_ONLN)
-int cpu_count() {
-  return Min(sysconf(_SC_NPROCESSORS_ONLN), 8);
-}
-#  else
-int cpu_count() {
-  return 1;
+  cond_timedwait(sleepCond, sleepLock, tm);
 }
-#  endif
 
-#else
 
-int cpu_count() {
-  SYSTEM_INFO s;
-  GetSystemInfo(&s);
-  return Min(s.dwNumberOfProcessors, 8);
-}
+/// 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)
 
-#endif
+void prefetch(char*) {}
 
+#else
 
-/*
-  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* addr) {
 
-#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;
+#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
-    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;
-    }
+
+  _mm_prefetch(addr, _MM_HINT_T2);
+  _mm_prefetch(addr+64, _MM_HINT_T2); // 64 bytes ahead
 }
+
 #endif