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-2015 Marco Costalba, Joona Kiiski, Tord Romstad
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.
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.
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/>.
32 /// Version number. If Version is left empty, then compile date in the format
33 /// DD-MM-YY and show in engine_info.
34 const string Version = "";
37 int64_t hits[2], means[2];
39 /// Our fancy logging facility. The trick here is to replace cin.rdbuf() and
40 /// cout.rdbuf() with two Tie objects that tie cin and cout to a file stream. We
41 /// can toggle the logging of std::cout and std:cin at runtime whilst preserving
42 /// usual i/o functionality, all without changing a single line of code!
43 /// Idea from http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81
45 struct Tie: public streambuf { // MSVC requires splitted streambuf for cin and cout
47 Tie(streambuf* b, ofstream* f) : buf(b), file(f) {}
49 int sync() { return file->rdbuf()->pubsync(), buf->pubsync(); }
50 int overflow(int c) { return log(buf->sputc((char)c), "<< "); }
51 int underflow() { return buf->sgetc(); }
52 int uflow() { return log(buf->sbumpc(), ">> "); }
57 int log(int c, const char* prefix) {
59 static int last = '\n';
62 file->rdbuf()->sputn(prefix, 3);
64 return last = file->rdbuf()->sputc((char)c);
70 Logger() : in(cin.rdbuf(), &file), out(cout.rdbuf(), &file) {}
71 ~Logger() { start(false); }
77 static void start(bool b) {
81 if (b && !l.file.is_open())
83 l.file.open("io_log.txt", ifstream::out | ifstream::app);
87 else if (!b && l.file.is_open())
89 cout.rdbuf(l.out.buf);
98 /// engine_info() returns the full name of the current Stockfish version. This
99 /// will be either "Stockfish <Tag> DD-MM-YY" (where DD-MM-YY is the date when
100 /// the program was compiled) or "Stockfish <Version>", depending on whether
101 /// Version is empty.
103 const string engine_info(bool to_uci) {
105 const string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
106 string month, day, year;
107 stringstream ss, date(__DATE__); // From compiler, format is "Sep 21 2008"
109 ss << "Stockfish " << Version << setfill('0');
113 date >> month >> day >> year;
114 ss << setw(2) << day << setw(2) << (1 + months.find(month) / 4) << year.substr(2);
117 ss << (Is64Bit ? " 64" : "")
118 << (HasPext ? " BMI2" : (HasPopCnt ? " POPCNT" : ""))
119 << (to_uci ? "\nid author ": " by ")
120 << "Tord Romstad, Marco Costalba and Joona Kiiski";
126 /// Debug functions used mainly to collect run-time statistics
128 void dbg_hit_on(bool b) { ++hits[0]; if (b) ++hits[1]; }
129 void dbg_hit_on(bool c, bool b) { if (c) dbg_hit_on(b); }
130 void dbg_mean_of(int v) { ++means[0]; means[1] += v; }
135 cerr << "Total " << hits[0] << " Hits " << hits[1]
136 << " hit rate (%) " << 100 * hits[1] / hits[0] << endl;
139 cerr << "Total " << means[0] << " Mean "
140 << (double)means[1] / means[0] << endl;
144 /// Used to serialize access to std::cout to avoid multiple threads writing at
147 std::ostream& operator<<(std::ostream& os, SyncCout sc) {
161 /// Trampoline helper to avoid moving Logger to misc.h
162 void start_logger(bool b) { Logger::start(b); }
165 /// prefetch() preloads the given address in L1/L2 cache. This is a non-blocking
166 /// function that doesn't stall the CPU waiting for data to be loaded from memory,
167 /// which can be quite slow.
170 void prefetch(void*) {}
174 void prefetch(void* addr) {
176 # if defined(__INTEL_COMPILER)
177 // This hack prevents prefetches from being optimized away by
178 // Intel compiler. Both MSVC and gcc seem not be affected by this.
182 # if defined(__INTEL_COMPILER) || defined(_MSC_VER)
183 _mm_prefetch((char*)addr, _MM_HINT_T0);
185 __builtin_prefetch(addr);