99deedcc6a66f5e8d99086fa2baa2c4ccf59a2a9
[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 /// cpu_count() tries to detect the number of CPU cores
109
110 int cpu_count() {
111
112 #if defined(_WIN32) || defined(_WIN64)
113   SYSTEM_INFO s;
114   GetSystemInfo(&s);
115   return std::min(int(s.dwNumberOfProcessors), MAX_THREADS);
116 #else
117
118 #  if defined(_SC_NPROCESSORS_ONLN)
119   return std::min((int)sysconf(_SC_NPROCESSORS_ONLN), MAX_THREADS);
120 #  elif defined(__hpux)
121   struct pst_dynamic psd;
122   if (pstat_getdynamic(&psd, sizeof(psd), (size_t)1, 0) == -1)
123       return 1;
124   return std::min((int)psd.psd_proc_cnt, MAX_THREADS);
125 #  else
126   return 1;
127 #  endif
128
129 #endif
130 }
131
132
133 /// timed_wait() waits for msec milliseconds. It is mainly an helper to wrap
134 /// conversion from milliseconds to struct timespec, as used by pthreads.
135
136 void timed_wait(WaitCondition& sleepCond, Lock& sleepLock, int msec) {
137
138 #if defined(_WIN32) || defined(_WIN64)
139   int tm = msec;
140 #else
141   struct timeval t;
142   struct timespec abstime, *tm = &abstime;
143
144   gettimeofday(&t, NULL);
145
146   abstime.tv_sec = t.tv_sec + (msec / 1000);
147   abstime.tv_nsec = (t.tv_usec + (msec % 1000) * 1000) * 1000;
148
149   if (abstime.tv_nsec > 1000000000LL)
150   {
151       abstime.tv_sec += 1;
152       abstime.tv_nsec -= 1000000000LL;
153   }
154 #endif
155
156   cond_timedwait(sleepCond, sleepLock, tm);
157 }
158
159
160 /// prefetch() preloads the given address in L1/L2 cache. This is a non
161 /// blocking function and do not stalls the CPU waiting for data to be
162 /// loaded from memory, that can be quite slow.
163 #if defined(NO_PREFETCH)
164
165 void prefetch(char*) {}
166
167 #else
168
169 void prefetch(char* addr) {
170
171 #  if defined(__INTEL_COMPILER) || defined(__ICL)
172    // This hack prevents prefetches to be optimized away by
173    // Intel compiler. Both MSVC and gcc seems not affected.
174    __asm__ ("");
175 #  endif
176
177   _mm_prefetch(addr, _MM_HINT_T2);
178   _mm_prefetch(addr+64, _MM_HINT_T2); // 64 bytes ahead
179 }
180
181 #endif