Simplify locking usage
[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(_MSC_VER)
21
22 #define _CRT_SECURE_NO_DEPRECATE
23 #define NOMINMAX // disable macros min() and max()
24 #include <windows.h>
25 #include <sys/timeb.h>
26
27 #else
28
29 #  include <sys/time.h>
30 #  include <sys/types.h>
31 #  include <unistd.h>
32 #  if defined(__hpux)
33 #     include <sys/pstat.h>
34 #  endif
35
36 #endif
37
38 #if !defined(NO_PREFETCH)
39 #  include <xmmintrin.h>
40 #endif
41
42 #include <algorithm>
43 #include <iomanip>
44 #include <iostream>
45 #include <sstream>
46
47 #include "misc.h"
48 #include "thread.h"
49
50 using namespace std;
51
52 /// Version number. If Version is left empty, then Tag plus current
53 /// date (in the format YYMMDD) is used as a version number.
54
55 static const string Version = "";
56 static const string Tag = "";
57
58
59 /// engine_info() returns the full name of the current Stockfish version.
60 /// This will be either "Stockfish YYMMDD" (where YYMMDD is the date when
61 /// the program was compiled) or "Stockfish <version number>", depending
62 /// on whether Version is empty.
63
64 const string engine_info(bool to_uci) {
65
66   const string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
67   const string cpu64(Is64Bit ? " 64bit" : "");
68   const string popcnt(HasPopCnt ? " SSE4.2" : "");
69
70   string month, day, year;
71   stringstream s, date(__DATE__); // From compiler, format is "Sep 21 2008"
72
73   if (Version.empty())
74   {
75       date >> month >> day >> year;
76
77       s << "Stockfish " << Tag
78         << setfill('0') << " " << year.substr(2)
79         << setw(2) << (1 + months.find(month) / 4)
80         << setw(2) << day << cpu64 << popcnt;
81   }
82   else
83       s << "Stockfish " << Version << cpu64 << popcnt;
84
85   s << (to_uci ? "\nid author ": " by ")
86     << "Tord Romstad, Marco Costalba and Joona Kiiski";
87
88   return s.str();
89 }
90
91
92 /// Debug functions used mainly to collect run-time statistics
93
94 static uint64_t hits[2], means[2];
95
96 void dbg_hit_on(bool b) { hits[0]++; if (b) hits[1]++; }
97 void dbg_hit_on_c(bool c, bool b) { if (c) dbg_hit_on(b); }
98 void dbg_mean_of(int v) { means[0]++; means[1] += v; }
99
100 void dbg_print() {
101
102   if (hits[0])
103       cerr << "Total " << hits[0] << " Hits " << hits[1]
104            << " hit rate (%) " << 100 * hits[1] / hits[0] << endl;
105
106   if (means[0])
107       cerr << "Total " << means[0] << " Mean "
108            << (float)means[1] / means[0] << endl;
109 }
110
111
112 /// system_time() returns the current system time, measured in milliseconds
113
114 int system_time() {
115
116 #if defined(_MSC_VER)
117   struct _timeb t;
118   _ftime(&t);
119   return int(t.time * 1000 + t.millitm);
120 #else
121   struct timeval t;
122   gettimeofday(&t, NULL);
123   return t.tv_sec * 1000 + t.tv_usec / 1000;
124 #endif
125 }
126
127
128 /// cpu_count() tries to detect the number of CPU cores
129
130 int cpu_count() {
131
132 #if defined(_MSC_VER)
133   SYSTEM_INFO s;
134   GetSystemInfo(&s);
135   return std::min(int(s.dwNumberOfProcessors), MAX_THREADS);
136 #else
137
138 #  if defined(_SC_NPROCESSORS_ONLN)
139   return std::min((int)sysconf(_SC_NPROCESSORS_ONLN), MAX_THREADS);
140 #  elif defined(__hpux)
141   struct pst_dynamic psd;
142   if (pstat_getdynamic(&psd, sizeof(psd), (size_t)1, 0) == -1)
143       return 1;
144   return std::min((int)psd.psd_proc_cnt, MAX_THREADS);
145 #  else
146   return 1;
147 #  endif
148
149 #endif
150 }
151
152
153 /// timed_wait() waits for msec milliseconds. It is mainly an helper to wrap
154 /// conversion from milliseconds to struct timespec, as used by pthreads.
155
156 void timed_wait(WaitCondition& sleepCond, Lock& sleepLock, int msec) {
157
158 #if defined(_MSC_VER)
159   int tm = msec;
160 #else
161   struct timeval t;
162   struct timespec abstime, *tm = &abstime;
163
164   gettimeofday(&t, NULL);
165
166   abstime.tv_sec = t.tv_sec + (msec / 1000);
167   abstime.tv_nsec = (t.tv_usec + (msec % 1000) * 1000) * 1000;
168
169   if (abstime.tv_nsec > 1000000000LL)
170   {
171       abstime.tv_sec += 1;
172       abstime.tv_nsec -= 1000000000LL;
173   }
174 #endif
175
176   cond_timedwait(sleepCond, sleepLock, tm);
177 }
178
179
180 /// prefetch() preloads the given address in L1/L2 cache. This is a non
181 /// blocking function and do not stalls the CPU waiting for data to be
182 /// loaded from memory, that can be quite slow.
183 #if defined(NO_PREFETCH)
184
185 void prefetch(char*) {}
186
187 #else
188
189 void prefetch(char* addr) {
190
191 #  if defined(__INTEL_COMPILER) || defined(__ICL)
192    // This hack prevents prefetches to be optimized away by
193    // Intel compiler. Both MSVC and gcc seems not affected.
194    __asm__ ("");
195 #  endif
196
197   _mm_prefetch(addr, _MM_HINT_T2);
198   _mm_prefetch(addr+64, _MM_HINT_T2); // 64 bytes ahead
199 }
200
201 #endif