Remove cruft from Logger class
[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-2012 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 #if defined(_WIN32) || defined(_WIN64)
21
22 #define NOMINMAX // disable macros min() and max()
23 #include <windows.h>
24
25 #else
26
27 #  include <unistd.h>
28 #  if defined(__hpux)
29 #     include <sys/pstat.h>
30 #  endif
31
32 #endif
33
34 #if !defined(NO_PREFETCH)
35 #  include <xmmintrin.h>
36 #endif
37
38 #include <algorithm>
39 #include <iomanip>
40 #include <iostream>
41 #include <sstream>
42
43 #include "misc.h"
44 #include "thread.h"
45
46 using namespace std;
47
48 /// Version number. If Version is left empty, then Tag plus current
49 /// date (in the format YYMMDD) is used as a version number.
50
51 static const string Version = "";
52 static const string Tag = "";
53
54
55 /// engine_info() returns the full name of the current Stockfish version.
56 /// This will be either "Stockfish YYMMDD" (where YYMMDD is the date when
57 /// the program was compiled) or "Stockfish <version number>", depending
58 /// on whether Version is empty.
59
60 const string engine_info(bool to_uci) {
61
62   const string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
63   const string cpu64(Is64Bit ? " 64bit" : "");
64   const string popcnt(HasPopCnt ? " SSE4.2" : "");
65
66   string month, day, year;
67   stringstream s, date(__DATE__); // From compiler, format is "Sep 21 2008"
68
69   if (Version.empty())
70   {
71       date >> month >> day >> year;
72
73       s << "Stockfish " << Tag
74         << setfill('0') << " " << year.substr(2)
75         << setw(2) << (1 + months.find(month) / 4)
76         << setw(2) << day;
77   }
78   else
79       s << "Stockfish " << Version;
80
81   s << cpu64 << popcnt << (to_uci ? "\nid author ": " by ")
82     << "Tord Romstad, Marco Costalba and Joona Kiiski";
83
84   return s.str();
85 }
86
87
88 /// Debug functions used mainly to collect run-time statistics
89
90 static uint64_t hits[2], means[2];
91
92 void dbg_hit_on(bool b) { hits[0]++; if (b) hits[1]++; }
93 void dbg_hit_on_c(bool c, bool b) { if (c) dbg_hit_on(b); }
94 void dbg_mean_of(int v) { means[0]++; means[1] += v; }
95
96 void dbg_print() {
97
98   if (hits[0])
99       cerr << "Total " << hits[0] << " Hits " << hits[1]
100            << " hit rate (%) " << 100 * hits[1] / hits[0] << endl;
101
102   if (means[0])
103       cerr << "Total " << means[0] << " Mean "
104            << (float)means[1] / means[0] << endl;
105 }
106
107
108 /// Our fancy logging facility. The trick here is to replace cin.rdbuf() and
109 /// cout.rdbuf() with this one that tees cin and cout to a file stream. We can
110 /// toggle the logging of std::cout and std:cin at runtime while preserving i/o
111 /// functionality and without changing a single line of code!
112 /// Idea from http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81
113
114 class Logger: public streambuf {
115
116   Logger() : cinbuf(cin.rdbuf()), coutbuf(cout.rdbuf()) {}
117   ~Logger() { start(false); }
118
119 public:
120   static void start(bool b) {
121
122     static Logger l;
123
124     if (b && !l.file.is_open())
125     {
126         l.file.open("io_log.txt", ifstream::out | ifstream::app);
127         cin.rdbuf(&l);
128         cout.rdbuf(&l);
129     }
130     else if (!b && l.file.is_open())
131     {
132         cout.rdbuf(l.coutbuf);
133         cin.rdbuf(l.cinbuf);
134         l.file.close();
135     }
136   }
137
138 private:
139   int sync() { return file.rdbuf()->pubsync(), coutbuf->pubsync(); }
140   int overflow(int c) { return log(coutbuf->sputc((char)c), "<< ") ; }
141   int underflow() { return cinbuf->sgetc(); }
142   int uflow() { return log(cinbuf->sbumpc(), ">> "); }
143
144   int log(int c, const char* prefix) {
145
146     static int last = '\n';
147
148     if (last == '\n')
149         file.rdbuf()->sputn(prefix, 3);
150
151     return last = file.rdbuf()->sputc((char)c);
152   }
153
154 private:
155   ofstream file;
156   streambuf *cinbuf, *coutbuf;
157 };
158
159
160 /// Trampoline helper to avoid moving Logger to misc.h header
161 void start_logger(bool b) { Logger::start(b); }
162
163
164 /// cpu_count() tries to detect the number of CPU cores
165
166 int cpu_count() {
167
168 #if defined(_WIN32) || defined(_WIN64)
169   SYSTEM_INFO s;
170   GetSystemInfo(&s);
171   return std::min(int(s.dwNumberOfProcessors), MAX_THREADS);
172 #else
173
174 #  if defined(_SC_NPROCESSORS_ONLN)
175   return std::min((int)sysconf(_SC_NPROCESSORS_ONLN), MAX_THREADS);
176 #  elif defined(__hpux)
177   struct pst_dynamic psd;
178   if (pstat_getdynamic(&psd, sizeof(psd), (size_t)1, 0) == -1)
179       return 1;
180   return std::min((int)psd.psd_proc_cnt, MAX_THREADS);
181 #  else
182   return 1;
183 #  endif
184
185 #endif
186 }
187
188
189 /// timed_wait() waits for msec milliseconds. It is mainly an helper to wrap
190 /// conversion from milliseconds to struct timespec, as used by pthreads.
191
192 void timed_wait(WaitCondition& sleepCond, Lock& sleepLock, int msec) {
193
194 #if defined(_WIN32) || defined(_WIN64)
195   int tm = msec;
196 #else
197   timespec ts, *tm = &ts;
198   uint64_t ms = Time::current_time().msec() + msec;
199
200   ts.tv_sec = ms / 1000;
201   ts.tv_nsec = (ms % 1000) * 1000000LL;
202 #endif
203
204   cond_timedwait(sleepCond, sleepLock, tm);
205 }
206
207
208 /// prefetch() preloads the given address in L1/L2 cache. This is a non
209 /// blocking function and do not stalls the CPU waiting for data to be
210 /// loaded from memory, that can be quite slow.
211 #if defined(NO_PREFETCH)
212
213 void prefetch(char*) {}
214
215 #else
216
217 void prefetch(char* addr) {
218
219 #  if defined(__INTEL_COMPILER) || defined(__ICL)
220    // This hack prevents prefetches to be optimized away by
221    // Intel compiler. Both MSVC and gcc seems not affected.
222    __asm__ ("");
223 #  endif
224
225   _mm_prefetch(addr, _MM_HINT_T2);
226   _mm_prefetch(addr+64, _MM_HINT_T2); // 64 bytes ahead
227 }
228
229 #endif