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