Use #ifndef instead of #if !defined
[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-2013 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 #ifdef __hpux
28 #    include <sys/pstat.h>
29 #endif
30
31 using namespace std;
32
33 /// Version number. If Version is left empty, then compile date, in the
34 /// format DD-MM-YY, is shown in engine_info.
35 static const string Version = "";
36
37
38 /// engine_info() returns the full name of the current Stockfish version. This
39 /// will be either "Stockfish <Tag> DD-MM-YY" (where DD-MM-YY is the date when
40 /// the program was compiled) or "Stockfish <Version>", depending on whether
41 /// Version is empty.
42
43 const string engine_info(bool to_uci) {
44
45   const string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
46   string month, day, year;
47   stringstream s, date(__DATE__); // From compiler, format is "Sep 21 2008"
48
49   s << "Stockfish " << Version << setfill('0');
50
51   if (Version.empty())
52   {
53       date >> month >> day >> year;
54       s << setw(2) << day << setw(2) << (1 + months.find(month) / 4) << year.substr(2);
55   }
56
57   s << (Is64Bit ? " 64" : "")
58     << (HasPopCnt ? " SSE4.2" : "")
59     << (to_uci ? "\nid author ": " by ")
60     << "Tord Romstad, Marco Costalba and Joona Kiiski";
61
62   return s.str();
63 }
64
65
66 /// Convert system time to milliseconds. That's all we need.
67
68 Time::point Time::now() {
69   sys_time_t t; system_time(&t); return time_to_msec(t);
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 struct Tie: public streambuf { // MSVC requires splitted streambuf for cin and cout
100
101   Tie(streambuf* b, ofstream* f) : buf(b), file(f) {}
102
103   int sync() { return file->rdbuf()->pubsync(), buf->pubsync(); }
104   int overflow(int c) { return log(buf->sputc((char)c), "<< "); }
105   int underflow() { return buf->sgetc(); }
106   int uflow() { return log(buf->sbumpc(), ">> "); }
107
108   streambuf* buf;
109   ofstream* file;
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
122 class Logger {
123
124   Logger() : in(cin.rdbuf(), &file), out(cout.rdbuf(), &file) {}
125  ~Logger() { start(false); }
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 /// Used to serialize access to std::cout to avoid multiple threads to write at
152 /// the same time.
153
154 std::ostream& operator<<(std::ostream& os, SyncCout sc) {
155
156   static Mutex m;
157
158   if (sc == io_lock)
159       m.lock();
160
161   if (sc == io_unlock)
162       m.unlock();
163
164   return os;
165 }
166
167
168 /// Trampoline helper to avoid moving Logger to misc.h
169 void start_logger(bool b) { Logger::start(b); }
170
171
172 /// cpu_count() tries to detect the number of CPU cores
173
174 int cpu_count() {
175
176 #ifdef _WIN32
177   SYSTEM_INFO s;
178   GetSystemInfo(&s);
179   return s.dwNumberOfProcessors;
180 #else
181
182 #  if defined(_SC_NPROCESSORS_ONLN)
183   return sysconf(_SC_NPROCESSORS_ONLN);
184 #  elif defined(__hpux)
185   struct pst_dynamic psd;
186   if (pstat_getdynamic(&psd, sizeof(psd), (size_t)1, 0) == -1)
187       return 1;
188   return psd.psd_proc_cnt;
189 #  else
190   return 1;
191 #  endif
192
193 #endif
194 }
195
196
197 /// timed_wait() waits for msec milliseconds. It is mainly an helper to wrap
198 /// conversion from milliseconds to struct timespec, as used by pthreads.
199
200 void timed_wait(WaitCondition& sleepCond, Lock& sleepLock, int msec) {
201
202 #ifdef _WIN32
203   int tm = msec;
204 #else
205   timespec ts, *tm = &ts;
206   uint64_t ms = Time::now() + msec;
207
208   ts.tv_sec = ms / 1000;
209   ts.tv_nsec = (ms % 1000) * 1000000LL;
210 #endif
211
212   cond_timedwait(sleepCond, sleepLock, tm);
213 }
214
215
216 /// prefetch() preloads the given address in L1/L2 cache. This is a non
217 /// blocking function and do not stalls the CPU waiting for data to be
218 /// loaded from memory, that can be quite slow.
219 #ifdef NO_PREFETCH
220
221 void prefetch(char*) {}
222
223 #else
224
225 void prefetch(char* addr) {
226
227 #  if defined(__INTEL_COMPILER)
228    // This hack prevents prefetches to be optimized away by
229    // Intel compiler. Both MSVC and gcc seems not affected.
230    __asm__ ("");
231 #  endif
232
233 #  if defined(__INTEL_COMPILER) || defined(_MSC_VER)
234   _mm_prefetch(addr, _MM_HINT_T0);
235 #  else
236   __builtin_prefetch(addr);
237 #  endif
238 }
239
240 #endif