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