7a05970d2abcb45a96333a34a070504941ac3b20
[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 #include "types.h"
26
27 // Select type of intrinsic bit count instruction to use, see
28 // README.txt on how to pgo compile with POPCNT support.
29
30 #if defined(__INTEL_COMPILER) && defined(USE_POPCNT) // Intel compiler
31
32 #include <nmmintrin.h>
33
34 inline bool cpu_has_popcnt() {
35
36   int CPUInfo[4] = {-1};
37   __cpuid(CPUInfo, 0x00000001);
38   return (CPUInfo[2] >> 23) & 1;
39 }
40
41 #define POPCNT_INTRINSIC(x) _mm_popcnt_u64(x)
42
43 #elif defined(_MSC_VER) && defined(USE_POPCNT) // Microsoft compiler
44
45 #include <intrin.h>
46
47 inline bool cpu_has_popcnt() {
48
49   int CPUInfo[4] = {-1};
50   __cpuid(CPUInfo, 0x00000001);
51   return (CPUInfo[2] >> 23) & 1;
52 }
53
54 #define POPCNT_INTRINSIC(x) (int)__popcnt64(x)
55
56 #elif defined(__GNUC__) && defined(USE_POPCNT) // Gcc compiler
57
58 inline void __cpuid(unsigned int op,
59                     unsigned int *eax, unsigned int *ebx,
60                     unsigned int *ecx, unsigned int *edx)
61 {
62   *eax = op;
63   *ecx = 0;
64   __asm__("cpuid" : "=a" (*eax), "=b" (*ebx), "=c" (*ecx), "=d" (*edx)
65                   : "0" (*eax), "2" (*ecx));
66 }
67
68 inline bool cpu_has_popcnt() {
69
70   unsigned int eax, ebx, ecx, edx;
71   __cpuid(1, &eax, &ebx, &ecx, &edx);
72   return (ecx >> 23) & 1;
73 }
74
75 #define POPCNT_INTRINSIC(x) ({ \
76    unsigned long __ret; \
77    __asm__("popcnt %1, %0" : "=r" (__ret) : "r" (x)); \
78    __ret; })
79
80 #else // Safe fallback for unsupported compilers or when USE_POPCNT is disabled
81
82 inline bool cpu_has_popcnt() { return false; }
83
84 #define POPCNT_INTRINSIC(x) 0
85
86 #endif // cpu_has_popcnt() and POPCNT_INTRINSIC() definitions
87
88
89 /// Software implementation of bit count functions
90
91 #if defined(IS_64BIT)
92
93 inline int count_1s(Bitboard b) {
94   b -= ((b>>1) & 0x5555555555555555ULL);
95   b = ((b>>2) & 0x3333333333333333ULL) + (b & 0x3333333333333333ULL);
96   b = ((b>>4) + b) & 0x0F0F0F0F0F0F0F0FULL;
97   b *= 0x0101010101010101ULL;
98   return int(b >> 56);
99 }
100
101 inline int count_1s_max_15(Bitboard b) {
102   b -= (b>>1) & 0x5555555555555555ULL;
103   b = ((b>>2) & 0x3333333333333333ULL) + (b & 0x3333333333333333ULL);
104   b *= 0x1111111111111111ULL;
105   return int(b >> 60);
106 }
107
108 #else // if !defined(IS_64BIT)
109
110 inline int count_1s(Bitboard b) {
111   unsigned w = unsigned(b >> 32), v = unsigned(b);
112   v -= (v >> 1) & 0x55555555; // 0-2 in 2 bits
113   w -= (w >> 1) & 0x55555555;
114   v = ((v >> 2) & 0x33333333) + (v & 0x33333333); // 0-4 in 4 bits
115   w = ((w >> 2) & 0x33333333) + (w & 0x33333333);
116   v = ((v >> 4) + v) & 0x0F0F0F0F; // 0-8 in 8 bits
117   v += (((w >> 4) + w) & 0x0F0F0F0F);  // 0-16 in 8 bits
118   v *= 0x01010101; // mul is fast on amd procs
119   return int(v >> 24);
120 }
121
122 inline int count_1s_max_15(Bitboard b) {
123   unsigned w = unsigned(b >> 32), v = unsigned(b);
124   v -= (v >> 1) & 0x55555555; // 0-2 in 2 bits
125   w -= (w >> 1) & 0x55555555;
126   v = ((v >> 2) & 0x33333333) + (v & 0x33333333); // 0-4 in 4 bits
127   w = ((w >> 2) & 0x33333333) + (w & 0x33333333);
128   v += w; // 0-8 in 4 bits
129   v *= 0x11111111;
130   return int(v >> 28);
131 }
132
133 #endif // BITCOUNT
134
135
136 /// count_1s() counts the number of nonzero bits in a bitboard.
137 /// If template parameter is true an intrinsic is called, otherwise
138 /// we fallback on a software implementation.
139
140 template<bool UseIntrinsic>
141 inline int count_1s(Bitboard b) {
142
143   return UseIntrinsic ? POPCNT_INTRINSIC(b) : count_1s(b);
144 }
145
146 template<bool UseIntrinsic>
147 inline int count_1s_max_15(Bitboard b) {
148
149   return UseIntrinsic ? POPCNT_INTRINSIC(b) : count_1s_max_15(b);
150 }
151
152
153 // Global constant initialized at startup that is set to true if
154 // CPU on which application runs supports POPCNT intrinsic. Unless
155 // USE_POPCNT is not defined.
156 const bool CpuHasPOPCNT = cpu_has_popcnt();
157
158
159 // Global constant used to print info about the use of 64 optimized
160 // functions to verify that a 64 bit compile has been correctly built.
161 #if defined(IS_64BIT)
162 const bool CpuHas64BitPath = true;
163 #else
164 const bool CpuHas64BitPath = false;
165 #endif
166
167 #endif // !defined(BITCOUNT_H_INCLUDED)