/*
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-2014 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/>.
*/
+#include <fstream>
+#include <iomanip>
+#include <iostream>
+#include <sstream>
-////
-//// Includes
-////
+#include "misc.h"
+#include "thread.h"
-#if !defined(_MSC_VER)
+using namespace std;
-# include <sys/time.h>
-# include <sys/types.h>
-# include <unistd.h>
+namespace {
-#else
-/*
- (c) Copyright 1992 Eric Backus
+/// Version number. If Version is left empty, then compile date in the format
+/// DD-MM-YY and show in engine_info.
+const string Version = "";
- This software may be used freely so long as this copyright notice is
- left intact. There is no warrantee on this software.
-*/
-# include <windows.h>
-# include <time.h>
-# include "dos.h"
+/// Debug counters
+int64_t hits[2], means[2];
-static int gettimeofday(struct timeval* tp, struct timezone*)
-{
- SYSTEMTIME systime;
+/// 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 whilst preserving
+/// usual i/o functionality, all without changing a single line of code!
+/// Idea from http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81
- if (tp)
- {
- struct tm tmrec;
- time_t theTime = time(NULL);
+struct Tie: public streambuf { // MSVC requires splitted streambuf for cin and cout
- tmrec = *localtime(&theTime);
- tp->tv_sec = mktime(&tmrec);
- GetLocalTime(&systime); /* system time */
+ Tie(streambuf* b, ofstream* f) : buf(b), file(f) {}
- tp->tv_usec = systime.wMilliseconds * 1000;
- }
- return 0;
-}
+ 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(), ">> "); }
-#endif
+ streambuf* buf;
+ ofstream* file;
-#include <cassert>
-#include <cstdio>
-#include <iomanip>
-#include <iostream>
-#include <sstream>
+ int log(int c, const char* prefix) {
-#include "bitcount.h"
-#include "misc.h"
+ static int last = '\n';
-using namespace std;
+ if (last == '\n')
+ file->rdbuf()->sputn(prefix, 3);
-/// Version number. If this is left empty, the current date (in the format
-/// YYMMDD) is used as a version number.
+ return last = file->rdbuf()->sputc((char)c);
+ }
+};
-static const string EngineVersion = "";
-static const string AppName = "Stockfish";
-static const string AppTag = "";
+class Logger {
+ Logger() : in(cin.rdbuf(), &file), out(cout.rdbuf(), &file) {}
+ ~Logger() { start(false); }
-////
-//// Variables
-////
+ ofstream file;
+ Tie in, out;
-bool Chess960;
+public:
+ static void start(bool b) {
-uint64_t dbg_cnt0 = 0;
-uint64_t dbg_cnt1 = 0;
+ static Logger l;
-bool dbg_show_mean = false;
-bool dbg_show_hit_rate = false;
+ 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();
+ }
+ }
+};
+} // namespace
-////
-//// Functions
-////
+/// engine_info() returns the full name of the current Stockfish version. This
+/// will be either "Stockfish <Tag> DD-MM-YY" (where DD-MM-YY is the date when
+/// the program was compiled) or "Stockfish <Version>", depending on whether
+/// Version is empty.
-void dbg_hit_on(bool b) {
+const string engine_info(bool to_uci) {
- assert(!dbg_show_mean);
- dbg_show_hit_rate = true;
- dbg_cnt0++;
- if (b)
- dbg_cnt1++;
-}
+ const string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
+ string month, day, year;
+ stringstream ss, date(__DATE__); // From compiler, format is "Sep 21 2008"
-void dbg_hit_on_c(bool c, bool b) {
+ ss << "Stockfish " << Version << setfill('0');
- if (c)
- dbg_hit_on(b);
-}
+ if (Version.empty())
+ {
+ date >> month >> day >> year;
+ ss << setw(2) << day << setw(2) << (1 + months.find(month) / 4) << year.substr(2);
+ }
-void dbg_before() {
+ ss << (Is64Bit ? " 64" : "")
+ << (HasPext ? " BMI2" : (HasPopCnt ? " POPCNT" : ""))
+ << (to_uci ? "\nid author ": " by ")
+ << "Tord Romstad, Marco Costalba and Joona Kiiski";
- assert(!dbg_show_mean);
- dbg_show_hit_rate = true;
- dbg_cnt0++;
+ return ss.str();
}
-void dbg_after() {
- assert(!dbg_show_mean);
- dbg_show_hit_rate = true;
- dbg_cnt1++;
-}
+/// Debug functions used mainly to collect run-time statistics
-void dbg_mean_of(int v) {
+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; }
- assert(!dbg_show_hit_rate);
- dbg_show_mean = true;
- dbg_cnt0++;
- dbg_cnt1 += v;
-}
+void dbg_print() {
-void dbg_print_hit_rate() {
+ if (hits[0])
+ cerr << "Total " << hits[0] << " Hits " << hits[1]
+ << " hit rate (%) " << 100 * hits[1] / hits[0] << endl;
- cout << "Total " << dbg_cnt0 << " Hit " << dbg_cnt1
- << " hit rate (%) " << (dbg_cnt1*100)/(dbg_cnt0 ? dbg_cnt0 : 1) << endl;
+ if (means[0])
+ cerr << "Total " << means[0] << " Mean "
+ << (double)means[1] / means[0] << endl;
}
-void dbg_print_mean() {
-
- cout << "Total " << dbg_cnt0 << " Mean "
- << (float)dbg_cnt1 / (dbg_cnt0 ? dbg_cnt0 : 1) << endl;
-}
-void dbg_print_hit_rate(ofstream& logFile) {
+/// Used to serialize access to std::cout to avoid multiple threads writing at
+/// the same time.
- logFile << "Total " << dbg_cnt0 << " Hit " << dbg_cnt1
- << " hit rate (%) " << (dbg_cnt1*100)/(dbg_cnt0 ? dbg_cnt0 : 1) << endl;
-}
+std::ostream& operator<<(std::ostream& os, SyncCout sc) {
-void dbg_print_mean(ofstream& logFile) {
+ static Mutex m;
- logFile << "Total " << dbg_cnt0 << " Mean "
- << (float)dbg_cnt1 / (dbg_cnt0 ? dbg_cnt0 : 1) << endl;
-}
+ if (sc == IO_LOCK)
+ m.lock();
-/// 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 (sc == IO_UNLOCK)
+ m.unlock();
-const string engine_name() {
+ return os;
+}
- const string cpu64(CpuHas64BitPath ? " 64bit" : "");
- if (!EngineVersion.empty())
- return AppName+ " " + EngineVersion + cpu64;
+/// Trampoline helper to avoid moving Logger to misc.h
+void start_logger(bool b) { Logger::start(b); }
- string date(__DATE__); // From compiler, format is "Sep 21 2008"
- string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
- size_t mon = 1 + months.find(date.substr(0, 3)) / 4;
+/// timed_wait() waits for msec milliseconds. It is mainly a helper to wrap
+/// the conversion from milliseconds to struct timespec, as used by pthreads.
- stringstream s;
- string day = (date[4] == ' ' ? date.substr(5, 1) : date.substr(4, 2));
+void timed_wait(WaitCondition& sleepCond, Lock& sleepLock, int msec) {
- string name = AppName + " " + AppTag + " ";
+#ifdef _WIN32
+ int tm = msec;
+#else
+ timespec ts, *tm = &ts;
+ uint64_t ms = Time::now() + msec;
- s << name << date.substr(date.length() - 2) << setfill('0')
- << setw(2) << mon << setw(2) << day << cpu64;
+ ts.tv_sec = ms / 1000;
+ ts.tv_nsec = (ms % 1000) * 1000000LL;
+#endif
- return s.str();
+ cond_timedwait(sleepCond, sleepLock, tm);
}
-/// get_system_time() returns the current system time, measured in
-/// milliseconds.
+/// prefetch() preloads the given address in L1/L2 cache. This is a non-blocking
+/// function that doesn't stall the CPU waiting for data to be loaded from memory,
+/// which can be quite slow.
+#ifdef NO_PREFETCH
-int get_system_time() {
- struct timeval t;
- gettimeofday(&t, NULL);
- return t.tv_sec*1000 + t.tv_usec/1000;
-}
+void prefetch(char*) {}
+#else
-/// cpu_count() tries to detect the number of CPU cores.
+void prefetch(char* addr) {
-#if !defined(_MSC_VER)
+# if defined(__INTEL_COMPILER)
+ // This hack prevents prefetches from being optimized away by
+ // Intel compiler. Both MSVC and gcc seem not be affected by this.
+ __asm__ ("");
+# endif
-# if defined(_SC_NPROCESSORS_ONLN)
-int cpu_count() {
- return Min(sysconf(_SC_NPROCESSORS_ONLN), 8);
-}
+# if defined(__INTEL_COMPILER) || defined(_MSC_VER)
+ _mm_prefetch(addr, _MM_HINT_T0);
# else
-int cpu_count() {
- return 1;
-}
+ __builtin_prefetch(addr);
# endif
-
-#else
-
-int cpu_count() {
- SYSTEM_INFO s;
- GetSystemInfo(&s);
- return Min(s.dwNumberOfProcessors, 8);
}
#endif
-
-
-/*
- 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));
-}
-
-#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;
- }
-}
-#endif