bitarithm.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2017 Kaspar Schleiser <kaspar@schleiser.de>
3  * 2014 Freie Universität Berlin
4  *
5  * This file is subject to the terms and conditions of the GNU Lesser
6  * General Public License v2.1. See the file LICENSE in the top level
7  * directory for more details.
8  */
9 
21 #ifndef BITARITHM_H
22 #define BITARITHM_H
23 
24 #include <stdint.h>
25 
26 #include "cpu_conf.h"
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
41 #define SETBIT(val, bit) val |= (bit)
42 
52 #define CLRBIT(val, bit) val &= (~(bit))
53 
58 #ifndef BIT0
59 #define BIT0 0x00000001
60 #define BIT1 0x00000002
61 #define BIT2 0x00000004
62 #define BIT3 0x00000008
63 #define BIT4 0x00000010
64 #define BIT5 0x00000020
65 #define BIT6 0x00000040
66 #define BIT7 0x00000080
67 #define BIT8 0x00000100
68 #define BIT9 0x00000200
69 #define BIT10 0x00000400
70 #define BIT11 0x00000800
71 #define BIT12 0x00001000
72 #define BIT13 0x00002000
73 #define BIT14 0x00004000
74 #define BIT15 0x00008000
75 #endif
76 #ifndef BIT16
77 #define BIT16 0x00010000
78 #define BIT17 0x00020000
79 #define BIT18 0x00040000
80 #define BIT19 0x00080000
81 #define BIT20 0x00100000
82 #define BIT21 0x00200000
83 #define BIT22 0x00400000
84 #define BIT23 0x00800000
85 #define BIT24 0x01000000
86 #define BIT25 0x02000000
87 #define BIT26 0x04000000
88 #define BIT27 0x08000000
89 #define BIT28 0x10000000
90 #define BIT29 0x20000000
91 #define BIT30 0x40000000
92 #define BIT31 0x80000000
93 #endif
94 
96 #define ARCH_32_BIT (__INT_MAX__ == 2147483647)
105 static inline unsigned bitarithm_msb(unsigned v);
106 
114 static inline unsigned bitarithm_lsb(unsigned v);
115 
122 unsigned bitarithm_bits_set(unsigned v);
123 
130 #if ARCH_32_BIT
131 static inline uint8_t bitarithm_bits_set_u32(uint32_t v)
132 {
133  return bitarithm_bits_set(v);
134 }
135 #else
136 uint8_t bitarithm_bits_set_u32(uint32_t v);
137 #endif
138 
147 unsigned bitarith_msb_32bit_no_native_clz(unsigned v);
148 
149 /* implementations */
150 
151 static inline unsigned bitarithm_msb(unsigned v)
152 {
153 #if defined(BITARITHM_HAS_CLZ)
154  return 8 * sizeof(v) - __builtin_clz(v) - 1;
155 #elif ARCH_32_BIT
157 #else
158  unsigned r = 0;
159  while (v >>= 1) { /* unroll for more speed... */
160  ++r;
161  }
162  return r;
163 #endif
164 }
165 
166 static inline unsigned bitarithm_lsb(unsigned v)
167 #if defined(BITARITHM_LSB_BUILTIN)
168 {
169  return __builtin_ffs(v) - 1;
170 }
171 #elif defined(BITARITHM_LSB_LOOKUP)
172 {
173 /* Source: http://graphics.stanford.edu/~seander/bithacks.html#ZerosOnRightMultLookup */
174  extern const uint8_t MultiplyDeBruijnBitPosition[32];
175  return MultiplyDeBruijnBitPosition[((uint32_t)((v & -v) * 0x077CB531U)) >>
176  27];
177 }
178 #else
179 {
180 /* Source: http://graphics.stanford.edu/~seander/bithacks.html#IntegerLogObvious */
181  unsigned r = 0;
182 
183  while ((v & 0x01) == 0) {
184  v >>= 1;
185  r++;
186  }
187 
188  return r;
189 }
190 #endif
191 
211 static inline unsigned bitarithm_test_and_clear(unsigned state, uint8_t *index)
212 {
213 #if defined(BITARITHM_HAS_CLZ)
214  *index = 8 * sizeof(state) - __builtin_clz(state) - 1;
215  return state & ~(1 << *index);
216 #elif defined(BITARITHM_LSB_LOOKUP)
217  /* Source: http://graphics.stanford.edu/~seander/bithacks.html#ZerosOnRightMultLookup */
218  extern const uint8_t MultiplyDeBruijnBitPosition[32];
219  uint32_t least_bit = state & -state;
220  *index = MultiplyDeBruijnBitPosition[(least_bit * 0x077CB531U) >> 27];
221  return state & ~least_bit;
222 #else
223  while ((state & 1) == 0) {
224  *index += 1;
225  state >>= 1;
226  }
227  return state & ~1;
228 #endif
229 }
230 
231 #ifdef __cplusplus
232 }
233 #endif
234 
235 #endif /* BITARITHM_H */
236 
bitarithm_lsb
static unsigned bitarithm_lsb(unsigned v)
Returns the number of the lowest '1' bit in a value.
Definition: bitarithm.h:166
bitarithm_bits_set_u32
uint8_t bitarithm_bits_set_u32(uint32_t v)
Returns the (uint32_t version) number of bits set in a value.
bitarithm_bits_set
unsigned bitarithm_bits_set(unsigned v)
Returns the number of bits set in a value.
bitarithm_msb
static unsigned bitarithm_msb(unsigned v)
Returns the number of the highest '1' bit in a value.
Definition: bitarithm.h:151
bitarithm_test_and_clear
static unsigned bitarithm_test_and_clear(unsigned state, uint8_t *index)
Used for iterating over the bits in state.
Definition: bitarithm.h:211
bitarith_msb_32bit_no_native_clz
unsigned bitarith_msb_32bit_no_native_clz(unsigned v)
Returns the number of the highest '1' bit in a value.