Stockfish 7 Beta 1
[stockfish] / src / misc.cpp
1 /*
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
5
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.
10
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.
15
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/>.
18 */
19
20 #include <fstream>
21 #include <iomanip>
22 #include <iostream>
23 #include <sstream>
24
25 #include "misc.h"
26 #include "thread.h"
27
28 using namespace std;
29
30 namespace {
31
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 = "7Beta1";
35
36 /// Our fancy logging facility. The trick here is to replace cin.rdbuf() and
37 /// cout.rdbuf() with two Tie objects that tie cin and cout to a file stream. We
38 /// can toggle the logging of std::cout and std:cin at runtime whilst preserving
39 /// usual I/O functionality, all without changing a single line of code!
40 /// Idea from http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81
41
42 struct Tie: public streambuf { // MSVC requires split streambuf for cin and cout
43
44   Tie(streambuf* b, streambuf* l) : buf(b), logBuf(l) {}
45
46   int sync() { return logBuf->pubsync(), buf->pubsync(); }
47   int overflow(int c) { return log(buf->sputc((char)c), "<< "); }
48   int underflow() { return buf->sgetc(); }
49   int uflow() { return log(buf->sbumpc(), ">> "); }
50
51   streambuf *buf, *logBuf;
52
53   int log(int c, const char* prefix) {
54
55     static int last = '\n'; // Single log file
56
57     if (last == '\n')
58         logBuf->sputn(prefix, 3);
59
60     return last = logBuf->sputc((char)c);
61   }
62 };
63
64 class Logger {
65
66   Logger() : in(cin.rdbuf(), file.rdbuf()), out(cout.rdbuf(), file.rdbuf()) {}
67  ~Logger() { start(false); }
68
69   ofstream file;
70   Tie in, out;
71
72 public:
73   static void start(bool b) {
74
75     static Logger l;
76
77     if (b && !l.file.is_open())
78     {
79         l.file.open("io_log.txt", ifstream::out);
80         cin.rdbuf(&l.in);
81         cout.rdbuf(&l.out);
82     }
83     else if (!b && l.file.is_open())
84     {
85         cout.rdbuf(l.out.buf);
86         cin.rdbuf(l.in.buf);
87         l.file.close();
88     }
89   }
90 };
91
92 } // namespace
93
94 /// engine_info() returns the full name of the current Stockfish version. This
95 /// will be either "Stockfish <Tag> DD-MM-YY" (where DD-MM-YY is the date when
96 /// the program was compiled) or "Stockfish <Version>", depending on whether
97 /// Version is empty.
98
99 const string engine_info(bool to_uci) {
100
101   const string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
102   string month, day, year;
103   stringstream ss, date(__DATE__); // From compiler, format is "Sep 21 2008"
104
105   ss << "Stockfish " << Version << setfill('0');
106
107   if (Version.empty())
108   {
109       date >> month >> day >> year;
110       ss << setw(2) << day << setw(2) << (1 + months.find(month) / 4) << year.substr(2);
111   }
112
113   ss << (Is64Bit ? " 64" : "")
114      << (HasPext ? " BMI2" : (HasPopCnt ? " POPCNT" : ""))
115      << (to_uci  ? "\nid author ": " by ")
116      << "T. Romstad, M. Costalba, J. Kiiski, G. Linscott";
117
118   return ss.str();
119 }
120
121
122 /// Debug functions used mainly to collect run-time statistics
123 static int64_t hits[2], means[2];
124
125 void dbg_hit_on(bool b) { ++hits[0]; if (b) ++hits[1]; }
126 void dbg_hit_on(bool c, bool b) { if (c) dbg_hit_on(b); }
127 void dbg_mean_of(int v) { ++means[0]; means[1] += v; }
128
129 void dbg_print() {
130
131   if (hits[0])
132       cerr << "Total " << hits[0] << " Hits " << hits[1]
133            << " hit rate (%) " << 100 * hits[1] / hits[0] << endl;
134
135   if (means[0])
136       cerr << "Total " << means[0] << " Mean "
137            << (double)means[1] / means[0] << endl;
138 }
139
140
141 /// Used to serialize access to std::cout to avoid multiple threads writing at
142 /// the same time.
143
144 std::ostream& operator<<(std::ostream& os, SyncCout sc) {
145
146   static Mutex m;
147
148   if (sc == IO_LOCK)
149       m.lock();
150
151   if (sc == IO_UNLOCK)
152       m.unlock();
153
154   return os;
155 }
156
157
158 /// Trampoline helper to avoid moving Logger to misc.h
159 void start_logger(bool b) { Logger::start(b); }
160
161
162 /// prefetch() preloads the given address in L1/L2 cache. This is a non-blocking
163 /// function that doesn't stall the CPU waiting for data to be loaded from memory,
164 /// which can be quite slow.
165 #ifdef NO_PREFETCH
166
167 void prefetch(void*) {}
168
169 #else
170
171 void prefetch(void* addr) {
172
173 #  if defined(__INTEL_COMPILER)
174    // This hack prevents prefetches from being optimized away by
175    // Intel compiler. Both MSVC and gcc seem not be affected by this.
176    __asm__ ("");
177 #  endif
178
179 #  if defined(__INTEL_COMPILER) || defined(_MSC_VER)
180   _mm_prefetch((char*)addr, _MM_HINT_T0);
181 #  else
182   __builtin_prefetch(addr);
183 #  endif
184 }
185
186 #endif