Debugging: move debug function definitions 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 Marco Costalba
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
21 ////
22 //// Includes
23 ////
24
25 #if !defined(_MSC_VER)
26
27 #  include <sys/time.h>
28 #  include <sys/types.h>
29 #  include <unistd.h>
30
31 #else
32
33 #  include <windows.h>
34 #  include <time.h>
35 #  include "dos.h"
36 int gettimeofday(struct timeval * tp, struct timezone * tzp);
37
38 #endif
39
40 #include <cassert>
41 #include <cstdio>
42 #include <iomanip>
43 #include <iostream>
44 #include <sstream>
45
46 #include "misc.h"
47
48
49 ////
50 //// Variables
51 ////
52
53 static const std::string AppName = "Stockfish";
54 static const std::string AppTag  = "";
55
56 long dbg_cnt0 = 0;
57 long dbg_cnt1 = 0;
58
59 bool dbg_show_mean = false;
60 bool dbg_show_hit_rate = false;
61
62
63 ////
64 //// Functions
65 ////
66
67 void dbg_hit_on(bool b) {
68
69     assert(!dbg_show_mean);
70     dbg_show_hit_rate = true;
71     dbg_cnt0++;
72     if (b)
73         dbg_cnt1++;
74 }
75
76 void dbg_hit_on_c(bool c, bool b) {
77
78     if (c)
79         dbg_hit_on(b);
80 }
81
82 void dbg_before() {
83
84     assert(!dbg_show_mean);
85     dbg_show_hit_rate = true;
86     dbg_cnt0++;
87 }
88
89 void dbg_after() {
90
91     assert(!dbg_show_mean);
92     dbg_show_hit_rate = true;
93     dbg_cnt1++;
94 }
95
96 void dbg_mean_of(int v) {
97
98     assert(!dbg_show_hit_rate);
99     dbg_cnt0++;
100     dbg_cnt1 += v;
101 }
102
103 void dbg_print_hit_rate() {
104
105   std::cout << "Total " << dbg_cnt0 << " Hit " << dbg_cnt1
106             << " hit rate (%) " << (dbg_cnt1*100)/(dbg_cnt0 ? dbg_cnt0 : 1)
107             << std::endl;
108 }
109
110 void dbg_print_mean() {
111
112   std::cout << "Total " << dbg_cnt0 << " Mean "
113             << (float)dbg_cnt1 / (dbg_cnt0 ? dbg_cnt0 : 1) << std::endl;
114 }
115
116 void dbg_print_hit_rate(std::ofstream& logFile) {
117
118   logFile << "Total " << dbg_cnt0 << " Hit " << dbg_cnt1
119           << " hit rate (%) " << (dbg_cnt1*100)/(dbg_cnt0 ? dbg_cnt0 : 1)
120           << std::endl;
121 }
122
123 void dbg_print_mean(std::ofstream& logFile) {
124
125   logFile << "Total " << dbg_cnt0 << " Mean "
126           << (float)dbg_cnt1 / (dbg_cnt0 ? dbg_cnt0 : 1) << std::endl;
127 }
128
129 /// engine_name() returns the full name of the current Stockfish version.
130 /// This will be either "Stockfish YYMMDD" (where YYMMDD is the date when the
131 /// program was compiled) or "Stockfish <version number>", depending on whether
132 /// the constant EngineVersion (defined in misc.h) is empty.
133
134 const std::string engine_name() {
135
136   if (EngineVersion.empty())
137   {
138       std::string date(__DATE__); // From compiler, format is "Sep 21 2008"
139       std::string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
140
141       size_t mon = 1 + months.find(date.substr(0, 3)) / 4;
142
143       std::stringstream s;
144       std::string day = (date[4] == ' ' ? date.substr(5, 1) : date.substr(4, 2));
145
146       std::string name = AppName + " " + AppTag + " ";
147
148       s << name << date.substr(date.length() - 2) << std::setfill('0')
149         << std::setw(2) << mon << std::setw(2) << day;
150
151       return s.str();
152   } else
153       return "Stockfish " + EngineVersion;
154 }
155
156
157 /// get_system_time() returns the current system time, measured in
158 /// milliseconds.
159
160 int get_system_time() {
161   struct timeval t;
162   gettimeofday(&t, NULL);
163   return t.tv_sec*1000 + t.tv_usec/1000;
164 }
165
166
167 /// cpu_count() tries to detect the number of CPU cores.
168
169 #if !defined(_MSC_VER)
170
171 #  if defined(_SC_NPROCESSORS_ONLN)
172 int cpu_count() {
173   return Min(sysconf(_SC_NPROCESSORS_ONLN), 8);
174 }
175 #  else
176 int cpu_count() {
177   return 1;
178 }
179 #  endif
180
181 #else
182
183 int cpu_count() {
184   SYSTEM_INFO s;
185   GetSystemInfo(&s);
186   return Min(s.dwNumberOfProcessors, 8);
187 }
188
189 #endif
190
191
192 /*
193   From Beowulf, from Olithink
194 */
195 #ifndef _WIN32
196 /* Non-windows version */
197 int Bioskey()
198 {
199   fd_set          readfds;
200   struct timeval  timeout;
201
202   FD_ZERO(&readfds);
203   FD_SET(fileno(stdin), &readfds);
204   /* Set to timeout immediately */
205   timeout.tv_sec = 0;
206   timeout.tv_usec = 0;
207   select(16, &readfds, 0, 0, &timeout);
208
209   return (FD_ISSET(fileno(stdin), &readfds));
210 }
211
212 #else
213 /* Windows-version */
214 #include <windows.h>
215 #include <conio.h>
216 int Bioskey()
217 {
218     static int      init = 0,
219                     pipe;
220     static HANDLE   inh;
221     DWORD           dw;
222     /* If we're running under XBoard then we can't use _kbhit() as the input
223      * commands are sent to us directly over the internal pipe */
224
225 #if defined(FILE_CNT)
226     if (stdin->_cnt > 0)
227         return stdin->_cnt;
228 #endif
229     if (!init) {
230         init = 1;
231         inh = GetStdHandle(STD_INPUT_HANDLE);
232         pipe = !GetConsoleMode(inh, &dw);
233         if (!pipe) {
234             SetConsoleMode(inh, dw & ~(ENABLE_MOUSE_INPUT | ENABLE_WINDOW_INPUT));
235             FlushConsoleInputBuffer(inh);
236         }
237     }
238     if (pipe) {
239         if (!PeekNamedPipe(inh, NULL, 0, NULL, &dw, NULL))
240             return 1;
241         return dw;
242     } else {
243         // Count the number of unread input records, including keyboard,
244         // mouse, and window-resizing input records.
245         GetNumberOfConsoleInputEvents(inh, &dw);
246         if (dw <= 0)
247             return 0;
248
249         // Read data from console without removing it from the buffer
250         INPUT_RECORD rec[256];
251         DWORD recCnt;
252         if (!PeekConsoleInput(inh, rec, Min(dw, 256), &recCnt))
253             return 0;
254
255         // Search for at least one keyboard event
256         for (DWORD i = 0; i < recCnt; i++)
257             if (rec[i].EventType == KEY_EVENT)
258                 return 1;
259
260         return 0;
261     }
262 }
263 #endif