Print info about use of 64bit functions and hardware POPCNT
[stockfish] / src / bitcount.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-2009 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
12   Stockfish is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21
22 #if !defined(BITCOUNT_H_INCLUDED)
23 #define BITCOUNT_H_INCLUDED
24
25 // To disable POPCNT support uncomment following line. You should do it only
26 // in PGO compiling to exercise the default fallback path. Don't forget to
27 // re-comment the line for the final optimized compile though ;-)
28 //#define DISABLE_POPCNT_SUPPORT
29
30
31 #include "bitboard.h"
32
33
34 // Select type of software bit count function to use
35
36 #if !defined(AUTO_CONFIGURATION) || defined(IS_64BIT)
37
38 //#define USE_COMPACT_ROOK_ATTACKS
39 //#define USE_32BIT_ATTACKS
40 #define USE_FOLDED_BITSCAN
41
42 #define BITCOUNT_SWAR_64
43 //#define BITCOUNT_SWAR_32
44 //#define BITCOUNT_LOOP
45
46 #else
47
48 #define USE_32BIT_ATTACKS
49 #define USE_FOLDED_BITSCAN
50 #define BITCOUNT_SWAR_32
51
52 #endif
53
54
55 // Select type of intrinsic bit count instruction to use
56
57 #if defined(_MSC_VER) && defined(_WIN64) // Microsoft compiler
58
59 #include <intrin.h>
60
61 inline bool cpu_has_popcnt() {
62
63   int CPUInfo[4] = {-1};
64   __cpuid(CPUInfo, 0x00000001);
65   return (CPUInfo[2] >> 23) & 1;
66 }
67
68 #define POPCNT_INTRINSIC(x) __popcnt64(x)
69
70 #elif defined(__INTEL_COMPILER) && (defined(__x86_64) || defined(_M_X64)) // Intel compiler
71
72 #include <nmmintrin.h>
73
74 inline bool cpu_has_popcnt() {
75
76   int CPUInfo[4] = {-1};
77   __cpuid(CPUInfo, 0x00000001);
78   return (CPUInfo[2] >> 23) & 1;
79 }
80
81 #define POPCNT_INTRINSIC(x) _mm_popcnt_u64(x)
82
83 #else // Safe fallback for unsupported compilers
84
85 inline bool cpu_has_popcnt() { return false; }
86
87 #define POPCNT_INTRINSIC(x) sw_count_1s(x)
88
89 #endif
90
91
92 /// Software implementation of bit count functions
93
94 #if defined(BITCOUNT_LOOP)
95
96 inline int sw_count_1s(Bitboard b) {
97   int r;
98   for(r = 0; b; r++, b &= b - 1);
99   return r;
100 }
101
102 inline int sw_count_1s_max_15(Bitboard b) {
103   return count_1s(b);
104 }
105
106 #elif defined(BITCOUNT_SWAR_32)
107
108 inline int sw_count_1s(Bitboard b) {
109   unsigned w = unsigned(b >> 32), v = unsigned(b);
110   v -= (v >> 1) & 0x55555555; // 0-2 in 2 bits
111   w -= (w >> 1) & 0x55555555;
112   v = ((v >> 2) & 0x33333333) + (v & 0x33333333); // 0-4 in 4 bits
113   w = ((w >> 2) & 0x33333333) + (w & 0x33333333);
114   v = ((v >> 4) + v) & 0x0F0F0F0F; // 0-8 in 8 bits
115   v += (((w >> 4) + w) & 0x0F0F0F0F);  // 0-16 in 8 bits
116   v *= 0x01010101; // mul is fast on amd procs
117   return int(v >> 24);
118 }
119
120 inline int sw_count_1s_max_15(Bitboard b) {
121   unsigned w = unsigned(b >> 32), v = unsigned(b);
122   v -= (v >> 1) & 0x55555555; // 0-2 in 2 bits
123   w -= (w >> 1) & 0x55555555;
124   v = ((v >> 2) & 0x33333333) + (v & 0x33333333); // 0-4 in 4 bits
125   w = ((w >> 2) & 0x33333333) + (w & 0x33333333);
126   v += w; // 0-8 in 4 bits
127   v *= 0x11111111;
128   return int(v >> 28);
129 }
130
131 #elif defined(BITCOUNT_SWAR_64)
132
133 inline int sw_count_1s(Bitboard b) {
134   b -= ((b>>1) & 0x5555555555555555ULL);
135   b = ((b>>2) & 0x3333333333333333ULL) + (b & 0x3333333333333333ULL);
136   b = ((b>>4) + b) & 0x0F0F0F0F0F0F0F0FULL;
137   b *= 0x0101010101010101ULL;
138   return int(b >> 56);
139 }
140
141 inline int sw_count_1s_max_15(Bitboard b) {
142   b -= (b>>1) & 0x5555555555555555ULL;
143   b = ((b>>2) & 0x3333333333333333ULL) + (b & 0x3333333333333333ULL);
144   b *= 0x1111111111111111ULL;
145   return int(b >> 60);
146 }
147
148 #endif // BITCOUNT
149
150
151 /// count_1s() counts the number of nonzero bits in a bitboard.
152 /// If template parameter is true an intrinsic is called, otherwise
153 /// we fallback on a software implementation.
154
155 template<bool UseIntrinsic>
156 inline int count_1s(Bitboard b) {
157
158   return UseIntrinsic ? POPCNT_INTRINSIC(b) : sw_count_1s(b);
159 }
160
161 template<bool UseIntrinsic>
162 inline int count_1s_max_15(Bitboard b) {
163
164   return UseIntrinsic ? POPCNT_INTRINSIC(b) : sw_count_1s_max_15(b);
165 }
166
167
168 // Global variable initialized at startup that is set to true if
169 // CPU on which application runs supports POPCNT intrinsic. Unless
170 // DISABLE_POPCNT_SUPPORT is defined.
171 #if defined(DISABLE_POPCNT_SUPPORT)
172 const bool CpuHasPOPCNT = false;
173 #else
174 const bool CpuHasPOPCNT = cpu_has_popcnt();
175 #endif
176
177
178 // Global variable used to print info about the use of 64 optimized
179 // functions to verify that a 64bit compile has been correctly built.
180 #if defined(BITCOUNT_SWAR_64)
181 const bool CpuHas64BitPath = true;
182 #else
183 const bool CpuHas64BitPath = false;
184 #endif
185
186 #endif // !defined(BITCOUNT_H_INCLUDED)