]> mj.ucw.cz Git - libucw.git/blob - ucw/bitarray.h
UCW::CGI: Documented the changes
[libucw.git] / ucw / bitarray.h
1 /*
2  *      UCW Library -- Bit Array Operations
3  *
4  *      (c) 2003--2006 Martin Mares <mj@ucw.cz>
5  *      (c) 2012 Pavel Charvat <pchar@ucw.cz>
6  *
7  *      This software may be freely distributed and used according to the terms
8  *      of the GNU Lesser General Public License.
9  */
10
11 #ifndef _UCW_BITARRAY_H
12 #define _UCW_BITARRAY_H
13
14 #include <string.h>
15
16 typedef u32 *bitarray_t; // Must be initialized by bit_array_xmalloc(), bit_array_zero() or bit_array_set_all()
17
18 #define BIT_ARRAY_WORDS(n) (((n)+31)/32)
19 #define BIT_ARRAY_BYTES(n) (4*BIT_ARRAY_WORDS(n))
20 #define BIT_ARRAY(name,size) u32 name[BIT_ARRAY_WORDS(size)]
21
22 static inline bitarray_t
23 bit_array_xmalloc(uns n)
24 {
25   return xmalloc(BIT_ARRAY_BYTES(n));
26 }
27
28 static inline bitarray_t
29 bit_array_xmalloc_zero(uns n)
30 {
31   return xmalloc_zero(BIT_ARRAY_BYTES(n));
32 }
33
34 static inline void
35 bit_array_zero(bitarray_t a, uns n)
36 {
37   bzero(a, BIT_ARRAY_BYTES(n));
38 }
39
40 static inline void
41 bit_array_set_all(bitarray_t a, uns n)
42 {
43   uns w = n / 32;
44   memset(a, 255, w * 4);
45   uns m = n & 31;
46   if (m)
47     a[w] = (1U << m) - 1;
48 }
49
50 static inline void
51 bit_array_set(bitarray_t a, uns i)
52 {
53   a[i/32] |= (1 << (i%32));
54 }
55
56 static inline void
57 bit_array_clear(bitarray_t a, uns i)
58 {
59   a[i/32] &= ~(1 << (i%32));
60 }
61
62 static inline void
63 bit_array_assign(bitarray_t a, uns i, uns x)
64 {
65   if (x)
66     bit_array_set(a, i);
67   else
68     bit_array_clear(a, i);
69 }
70
71 static inline uns
72 bit_array_isset(bitarray_t a, uns i)
73 {
74   return a[i/32] & (1 << (i%32));
75 }
76
77 static inline uns
78 bit_array_get(bitarray_t a, uns i)
79 {
80   return !! bit_array_isset(a, i);
81 }
82
83 static inline uns
84 bit_array_test_and_set(bitarray_t a, uns i)
85 {
86   uns t = bit_array_isset(a, i);
87   bit_array_set(a, i);
88   return t;
89 }
90
91 static inline uns
92 bit_array_test_and_clear(bitarray_t a, uns i)
93 {
94   uns t = bit_array_isset(a, i);
95   bit_array_clear(a, i);
96   return t;
97 }
98
99 uns bit_array_count_bits(bitarray_t a, uns n);
100
101 /* Iterate over all set bits */
102 #define BIT_ARRAY_FISH_BITS_BEGIN(var,ary,size)                                 \
103   for (uns var##_hi=0; var##_hi < BIT_ARRAY_WORDS(size); var##_hi++)            \
104     {                                                                           \
105       u32 var##_cur = ary[var##_hi];                                            \
106       for (uns var = 32 * var##_hi; var##_cur; var++, var##_cur >>= 1)          \
107         if (var##_cur & 1)                                                      \
108           do
109
110 #define BIT_ARRAY_FISH_BITS_END                                                 \
111           while (0);                                                            \
112     }
113
114 #endif