xref: /linux/drivers/md/persistent-data/dm-bitset.c (revision cb8fef4b07f71da01843457b66e579ad248a625e)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Copyright (C) 2012 Red Hat, Inc.
4  *
5  * This file is released under the GPL.
6  */
7 
8 #include "dm-bitset.h"
9 #include "dm-transaction-manager.h"
10 
11 #include <linux/export.h>
12 #include <linux/device-mapper.h>
13 
14 #define DM_MSG_PREFIX "bitset"
15 #define BITS_PER_ARRAY_ENTRY 64
16 
17 /*----------------------------------------------------------------*/
18 
19 static struct dm_btree_value_type bitset_bvt = {
20 	.context = NULL,
21 	.size = sizeof(__le64),
22 	.inc = NULL,
23 	.dec = NULL,
24 	.equal = NULL,
25 };
26 
27 /*----------------------------------------------------------------*/
28 
29 void dm_disk_bitset_init(struct dm_transaction_manager *tm,
30 			 struct dm_disk_bitset *info)
31 {
32 	dm_array_info_init(&info->array_info, tm, &bitset_bvt);
33 	info->current_index_set = false;
34 }
35 EXPORT_SYMBOL_GPL(dm_disk_bitset_init);
36 
37 int dm_bitset_empty(struct dm_disk_bitset *info, dm_block_t *root)
38 {
39 	return dm_array_empty(&info->array_info, root);
40 }
41 EXPORT_SYMBOL_GPL(dm_bitset_empty);
42 
43 struct packer_context {
44 	bit_value_fn fn;
45 	unsigned int nr_bits;
46 	void *context;
47 };
48 
49 static int pack_bits(uint32_t index, void *value, void *context)
50 {
51 	int r;
52 	struct packer_context *p = context;
53 	unsigned int bit, nr = min(64u, p->nr_bits - (index * 64));
54 	uint64_t word = 0;
55 	bool bv;
56 
57 	for (bit = 0; bit < nr; bit++) {
58 		r = p->fn(index * 64 + bit, &bv, p->context);
59 		if (r)
60 			return r;
61 
62 		assign_bit(bit, (unsigned long *)&word, bv);
63 	}
64 
65 	*((__le64 *) value) = cpu_to_le64(word);
66 
67 	return 0;
68 }
69 
70 int dm_bitset_new(struct dm_disk_bitset *info, dm_block_t *root,
71 		  uint32_t size, bit_value_fn fn, void *context)
72 {
73 	struct packer_context p;
74 
75 	p.fn = fn;
76 	p.nr_bits = size;
77 	p.context = context;
78 
79 	return dm_array_new(&info->array_info, root, dm_div_up(size, 64), pack_bits, &p);
80 }
81 EXPORT_SYMBOL_GPL(dm_bitset_new);
82 
83 int dm_bitset_resize(struct dm_disk_bitset *info, dm_block_t root,
84 		     uint32_t old_nr_entries, uint32_t new_nr_entries,
85 		     bool default_value, dm_block_t *new_root)
86 {
87 	uint32_t old_blocks = dm_div_up(old_nr_entries, BITS_PER_ARRAY_ENTRY);
88 	uint32_t new_blocks = dm_div_up(new_nr_entries, BITS_PER_ARRAY_ENTRY);
89 	__le64 value = default_value ? cpu_to_le64(~0) : cpu_to_le64(0);
90 
91 	__dm_bless_for_disk(&value);
92 	return dm_array_resize(&info->array_info, root, old_blocks, new_blocks,
93 			       &value, new_root);
94 }
95 EXPORT_SYMBOL_GPL(dm_bitset_resize);
96 
97 int dm_bitset_del(struct dm_disk_bitset *info, dm_block_t root)
98 {
99 	return dm_array_del(&info->array_info, root);
100 }
101 EXPORT_SYMBOL_GPL(dm_bitset_del);
102 
103 int dm_bitset_flush(struct dm_disk_bitset *info, dm_block_t root,
104 		    dm_block_t *new_root)
105 {
106 	int r;
107 	__le64 value;
108 
109 	if (!info->current_index_set || !info->dirty)
110 		return 0;
111 
112 	value = cpu_to_le64(info->current_bits);
113 
114 	__dm_bless_for_disk(&value);
115 	r = dm_array_set_value(&info->array_info, root, info->current_index,
116 			       &value, new_root);
117 	if (r)
118 		return r;
119 
120 	info->current_index_set = false;
121 	info->dirty = false;
122 
123 	return 0;
124 }
125 EXPORT_SYMBOL_GPL(dm_bitset_flush);
126 
127 static int read_bits(struct dm_disk_bitset *info, dm_block_t root,
128 		     uint32_t array_index)
129 {
130 	int r;
131 	__le64 value;
132 
133 	r = dm_array_get_value(&info->array_info, root, array_index, &value);
134 	if (r)
135 		return r;
136 
137 	info->current_bits = le64_to_cpu(value);
138 	info->current_index_set = true;
139 	info->current_index = array_index;
140 	info->dirty = false;
141 
142 	return 0;
143 }
144 
145 static int get_array_entry(struct dm_disk_bitset *info, dm_block_t root,
146 			   uint32_t index, dm_block_t *new_root)
147 {
148 	int r;
149 	unsigned int array_index = index / BITS_PER_ARRAY_ENTRY;
150 
151 	if (info->current_index_set) {
152 		if (info->current_index == array_index)
153 			return 0;
154 
155 		r = dm_bitset_flush(info, root, new_root);
156 		if (r)
157 			return r;
158 	}
159 
160 	return read_bits(info, root, array_index);
161 }
162 
163 int dm_bitset_set_bit(struct dm_disk_bitset *info, dm_block_t root,
164 		      uint32_t index, dm_block_t *new_root)
165 {
166 	int r;
167 	unsigned int b = index % BITS_PER_ARRAY_ENTRY;
168 
169 	r = get_array_entry(info, root, index, new_root);
170 	if (r)
171 		return r;
172 
173 	set_bit(b, (unsigned long *) &info->current_bits);
174 	info->dirty = true;
175 
176 	return 0;
177 }
178 EXPORT_SYMBOL_GPL(dm_bitset_set_bit);
179 
180 int dm_bitset_clear_bit(struct dm_disk_bitset *info, dm_block_t root,
181 			uint32_t index, dm_block_t *new_root)
182 {
183 	int r;
184 	unsigned int b = index % BITS_PER_ARRAY_ENTRY;
185 
186 	r = get_array_entry(info, root, index, new_root);
187 	if (r)
188 		return r;
189 
190 	clear_bit(b, (unsigned long *) &info->current_bits);
191 	info->dirty = true;
192 
193 	return 0;
194 }
195 EXPORT_SYMBOL_GPL(dm_bitset_clear_bit);
196 
197 int dm_bitset_test_bit(struct dm_disk_bitset *info, dm_block_t root,
198 		       uint32_t index, dm_block_t *new_root, bool *result)
199 {
200 	int r;
201 	unsigned int b = index % BITS_PER_ARRAY_ENTRY;
202 
203 	r = get_array_entry(info, root, index, new_root);
204 	if (r)
205 		return r;
206 
207 	*result = test_bit(b, (unsigned long *) &info->current_bits);
208 	return 0;
209 }
210 EXPORT_SYMBOL_GPL(dm_bitset_test_bit);
211 
212 static int cursor_next_array_entry(struct dm_bitset_cursor *c)
213 {
214 	int r;
215 	__le64 *value;
216 
217 	r = dm_array_cursor_next(&c->cursor);
218 	if (r)
219 		return r;
220 
221 	dm_array_cursor_get_value(&c->cursor, (void **) &value);
222 	c->array_index++;
223 	c->bit_index = 0;
224 	c->current_bits = le64_to_cpu(*value);
225 	return 0;
226 }
227 
228 int dm_bitset_cursor_begin(struct dm_disk_bitset *info,
229 			   dm_block_t root, uint32_t nr_entries,
230 			   struct dm_bitset_cursor *c)
231 {
232 	int r;
233 	__le64 *value;
234 
235 	if (!nr_entries)
236 		return -ENODATA;
237 
238 	c->info = info;
239 	c->entries_remaining = nr_entries;
240 
241 	r = dm_array_cursor_begin(&info->array_info, root, &c->cursor);
242 	if (r)
243 		return r;
244 
245 	dm_array_cursor_get_value(&c->cursor, (void **) &value);
246 	c->array_index = 0;
247 	c->bit_index = 0;
248 	c->current_bits = le64_to_cpu(*value);
249 
250 	return r;
251 }
252 EXPORT_SYMBOL_GPL(dm_bitset_cursor_begin);
253 
254 void dm_bitset_cursor_end(struct dm_bitset_cursor *c)
255 {
256 	return dm_array_cursor_end(&c->cursor);
257 }
258 EXPORT_SYMBOL_GPL(dm_bitset_cursor_end);
259 
260 int dm_bitset_cursor_next(struct dm_bitset_cursor *c)
261 {
262 	int r = 0;
263 
264 	if (!c->entries_remaining)
265 		return -ENODATA;
266 
267 	c->entries_remaining--;
268 	if (++c->bit_index > 63)
269 		r = cursor_next_array_entry(c);
270 
271 	return r;
272 }
273 EXPORT_SYMBOL_GPL(dm_bitset_cursor_next);
274 
275 int dm_bitset_cursor_skip(struct dm_bitset_cursor *c, uint32_t count)
276 {
277 	int r;
278 	__le64 *value;
279 	uint32_t nr_array_skip;
280 	uint32_t remaining_in_word = 64 - c->bit_index;
281 
282 	if (c->entries_remaining < count)
283 		return -ENODATA;
284 
285 	if (count < remaining_in_word) {
286 		c->bit_index += count;
287 		c->entries_remaining -= count;
288 		return 0;
289 
290 	} else {
291 		c->entries_remaining -= remaining_in_word;
292 		count -= remaining_in_word;
293 	}
294 
295 	nr_array_skip = (count / 64) + 1;
296 	r = dm_array_cursor_skip(&c->cursor, nr_array_skip);
297 	if (r)
298 		return r;
299 
300 	dm_array_cursor_get_value(&c->cursor, (void **) &value);
301 	c->entries_remaining -= count;
302 	c->array_index += nr_array_skip;
303 	c->bit_index = count & 63;
304 	c->current_bits = le64_to_cpu(*value);
305 
306 	return 0;
307 }
308 EXPORT_SYMBOL_GPL(dm_bitset_cursor_skip);
309 
310 bool dm_bitset_cursor_get_value(struct dm_bitset_cursor *c)
311 {
312 	return test_bit(c->bit_index, (unsigned long *) &c->current_bits);
313 }
314 EXPORT_SYMBOL_GPL(dm_bitset_cursor_get_value);
315 
316 /*----------------------------------------------------------------*/
317