Add some check utils.
[bertos.git] / bertos / struct / bitarray.h
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos 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 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program 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, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2010 Develer S.r.l. (http://www.develer.com/)
30  * -->
31  *
32  * \brief Bitarray module
33  *
34  * \author Daniele Basile <asterix@develer.com>
35  *
36  * $WIZ$ module_name = "bitarray"
37  */
38
39 #ifndef STRUCT_BITARRAY_H
40 #define STRUCT_BITARRAY_H
41
42 #include <cfg/compiler.h>
43 #include <cfg/macros.h>
44 #include <cfg/debug.h>
45
46 #include <cpu/types.h>
47
48
49 #define ALLOC_BITARRAY(name, size)   uint8_t name[DIV_ROUNDUP((size), 8)]
50 #define BIT_ARRAY_SIZE(name)         (sizeof((name)) * 8)
51
52 INLINE void bitarray_set(int idx, uint8_t *bit_array, size_t len)
53 {
54         ASSERT((size_t)idx <= len);
55         int page = idx / 8;
56         uint8_t bit = idx % 8;
57
58         bit_array[page] |= BV(bit);
59 }
60
61 INLINE void bitarray_clear(int idx, uint8_t *bit_array, size_t len)
62 {
63         ASSERT((size_t)idx <= len);
64         int page = idx / 8;
65         uint8_t bit = idx % 8;
66
67         bit_array[page] &= ~BV(bit);
68 }
69
70 INLINE void bitarray_setOffset(int idx, int offset, uint8_t *bit_array, size_t len)
71 {
72         ASSERT((size_t)idx <= len);
73
74         for (int i = idx; i < offset + idx; i++)
75                 bitarray_set(i, bit_array, len);
76 }
77
78
79 INLINE void bitarray_clearOffset(int idx, int offset, uint8_t *bit_array, size_t len)
80 {
81         ASSERT((size_t)idx <= len);
82
83         for (int i = idx; i < offset + idx; i++)
84                 bitarray_clear(i, bit_array, len);
85 }
86
87 INLINE bool bitarray_check(int idx, uint8_t *bit_array, size_t len)
88 {
89         ASSERT((size_t)idx <= len);
90         int page = idx / 8;
91         uint8_t bit = idx % 8;
92
93         return (bit_array[page] & BV(bit));
94 }
95
96 INLINE bool bitarray_full(uint8_t *bit_array, size_t len)
97 {
98         int count = len;
99         for (size_t page = 0; page <= len / 8; page++)
100         {
101                 if (count < 8)
102                 {
103                         for (size_t i = page * 8; i <= len; i++)
104                                 if (!bitarray_check(i, bit_array, len))
105                                         return 0;
106                                 count--;
107                 }
108                 else
109                 {
110                         if (!(bit_array[page] == 0xff))
111                                 return 0;
112                 }
113                 count -= 8;
114         }
115
116         return 1;
117 }
118
119 /*
120  * Ugly!.. reformat it.
121  */
122 INLINE bool bitarray_blockFull(int idx, int offset, uint8_t *bit_array, size_t len)
123 {
124         ASSERT((size_t)(idx + offset) <= len);
125
126         for (int i = idx; i <= idx + offset; i++)
127                 if (!bitarray_check(i, bit_array, len))
128                         return 0;
129
130         return 1;
131 }
132
133
134 /*
135  * Ugly!.. reformat it.
136  */
137 INLINE bool bitarray_blockEmpty(int idx, int offset, uint8_t *bit_array, size_t len)
138 {
139         ASSERT((size_t)(idx + offset) <= len);
140
141         for (int i = idx; i <= idx + offset; i++)
142                 if (bitarray_check(i, bit_array, len))
143                         return 0;
144
145         return 1;
146 }
147
148
149 INLINE void bitarray_dump(uint8_t *bit_array, size_t len)
150 {
151         kprintf("bitarray size[%zu]bits\n", len);
152
153         int i = 0;
154         int j = 0;
155         int count = len;
156
157         while (count--)
158         {
159                 kprintf("%d", bitarray_check(i++, bit_array, len));
160                 if (j == 7)
161                 {
162                         kprintf("..%02x [%d]\n", bit_array[(i / 8) - 1], i);
163                         j = 0;
164                         continue;
165                 }
166                 j++;
167         }
168
169         if (j != 0)
170                 kprintf("..%02x [%d]\n", bit_array[i / 8], i);
171 }
172
173 int bitarray_testSetup(void);
174 int bitarray_testRun(void);
175 int bitarray_testTearDown(void);
176
177 #endif /* STRUCT_BITARRAY_H */