91563109f997187db40aaaaad8784ef75746f629
[stockfish] / src / types.h
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-2010 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
21 #if !defined(TYPES_H_INCLUDED)
22 #define TYPES_H_INCLUDED
23
24 #if !defined(_MSC_VER)
25
26 #include <inttypes.h>
27
28 #else
29
30 // Disable some silly and noisy warning from MSVC compiler
31 #pragma warning(disable: 4800) // Forcing value to bool 'true' or 'false'
32 #pragma warning(disable: 4127) // Conditional expression is constant
33
34 typedef __int8 int8_t;
35 typedef unsigned __int8 uint8_t;
36 typedef __int16 int16;
37 typedef unsigned __int16 uint16_t;
38 typedef __int32 int32_t;
39 typedef unsigned __int32 uint32_t;
40 typedef __int64 int64_t;
41 typedef unsigned __int64 uint64_t;
42
43 typedef __int16 int16_t;
44 typedef __int64 int64_t;
45
46 #endif // !defined(_MSC_VER)
47
48 // Hash keys
49 typedef uint64_t Key;
50
51 // Bitboard type
52 typedef uint64_t Bitboard;
53
54
55 ////
56 //// Configuration
57 ////
58
59 //// For Linux and OSX configuration is done automatically using Makefile.
60 //// To get started type "make help".
61 ////
62 //// For windows part of the configuration is detected automatically, but
63 //// some switches need to be set manually:
64 ////
65 //// -DNDEBUG       | Disable debugging mode. Use always.
66 ////
67 //// -DNO_PREFETCH  | Disable use of prefetch asm-instruction. A must if you want the
68 ////                | executable to run on some very old machines.
69 ////
70 //// -DUSE_POPCNT   | Add runtime support for use of popcnt asm-instruction.
71 ////                | Works only in 64-bit mode. For compiling requires hardware
72 ////                | with popcnt support. Around 4% speed-up.
73
74 // Automatic detection for 64-bit under Windows
75 #if defined(_WIN64)
76 #define IS_64BIT
77 #endif
78
79 // Automatic detection for use of bsfq asm-instruction under Windows.
80 // Works only in 64-bit mode. Does not work with MSVC.
81 #if defined(_WIN64) && defined(__INTEL_COMPILER)
82 #define USE_BSFQ
83 #endif
84
85 // Cache line alignment specification
86 #if defined(_MSC_VER) || defined(__INTEL_COMPILER)
87 #define CACHE_LINE_ALIGNMENT __declspec(align(64))
88 #else
89 #define CACHE_LINE_ALIGNMENT  __attribute__ ((aligned(64)))
90 #endif
91
92 // Define a __cpuid() function for gcc compilers, for Intel and MSVC
93 // is already available as an intrinsic.
94 #if defined(_MSC_VER)
95 #include <intrin.h>
96 #elif defined(__GNUC__) && (defined(__i386__) || defined(__x86_64__))
97 inline void __cpuid(int CPUInfo[4], int InfoType)
98 {
99   int* eax = CPUInfo + 0;
100   int* ebx = CPUInfo + 1;
101   int* ecx = CPUInfo + 2;
102   int* edx = CPUInfo + 3;
103
104   *eax = InfoType;
105   *ecx = 0;
106   __asm__("cpuid" : "=a" (*eax), "=b" (*ebx), "=c" (*ecx), "=d" (*edx)
107                   : "0" (*eax), "2" (*ecx));
108 }
109 #else
110 inline void __cpuid(int CPUInfo[4], int)
111 {
112    CPUInfo[0] = CPUInfo[1] = CPUInfo[2] = CPUInfo[3] = 0;
113 }
114 #endif
115
116
117 // Templetized operators used by enum types like Depth, Piece, Square and so on.
118 // We don't want to write the same inline for each different enum. Note that we
119 // pass by value to silence scaring warnings when using volatiles.
120 // Because these templates override common operators and are included in all the
121 // files, there is a possibility that the compiler silently performs some unwanted
122 // overrides. To avoid possible very nasty bugs the templates are disabled by default
123 // and must be enabled for each type on a case by case base. The enabling trick
124 // uses template specialization, namely we just declare following struct.
125 template<typename T> struct TempletizedOperator;
126
127 // Then to enable the enum type we use following macro that defines a specialization
128 // of TempletizedOperator for the given enum T. Here is defined typedef Not_Enabled.
129 // Name of typedef is chosen to produce somewhat informative compile error messages.
130 #define ENABLE_OPERATORS_ON(T)  \
131         template<> struct TempletizedOperator<T> { typedef T Not_Enabled; }
132
133 // Finally we use macro OK(T) to check if type T is enabled. The macro simply
134 // tries to use Not_Enabled, if was not previously defined a compile error occurs.
135 // The check is done fully at compile time and there is zero overhead at runtime.
136 #define OK(T) typedef typename TempletizedOperator<T>::Not_Enabled Type
137
138 template<typename T>
139 inline T operator+ (const T d1, const T d2) { OK(T); return T(int(d1) + int(d2)); }
140
141 template<typename T>
142 inline T operator- (const T d1, const T d2) { OK(T); return T(int(d1) - int(d2)); }
143
144 template<typename T>
145 inline T operator* (int i, const T d) { OK(T); return T(i * int(d)); }
146
147 template<typename T>
148 inline T operator* (const T d, int i) { OK(T); return T(int(d) * i); }
149
150 template<typename T>
151 inline T operator/ (const T d, int i) { OK(T); return T(int(d) / i); }
152
153 template<typename T>
154 inline T operator- (const T d) { OK(T); return T(-int(d)); }
155
156 template<typename T>
157 inline T operator++ (T& d, int) { OK(T); d = T(int(d) + 1); return d; }
158
159 template<typename T>
160 inline T operator-- (T& d, int) { OK(T); d = T(int(d) - 1); return d; }
161
162 template<typename T>
163 inline void operator+= (T& d1, const T d2) { OK(T); d1 = d1 + d2; }
164
165 template<typename T>
166 inline void operator-= (T& d1, const T d2) { OK(T); d1 = d1 - d2; }
167
168 template<typename T>
169 inline void operator*= (T& d, int i) { OK(T); d = T(int(d) * i); }
170
171 template<typename T>
172 inline void operator/= (T& d, int i) { OK(T); d = T(int(d) / i); }
173
174 #undef OK
175
176 #endif // !defined(TYPES_H_INCLUDED)