2 * Copyright (C) 2011 Red Hat, Inc.
4 * This file is released under the GPL.
7 #include "dm-space-map-common.h"
8 #include "dm-transaction-manager.h"
10 #include <linux/bitops.h>
11 #include <linux/device-mapper.h>
13 #define DM_MSG_PREFIX "space map common"
15 /*----------------------------------------------------------------*/
20 #define INDEX_CSUM_XOR 160478
22 static void index_prepare_for_write(struct dm_block_validator *v,
26 struct disk_metadata_index *mi_le = dm_block_data(b);
28 mi_le->blocknr = cpu_to_le64(dm_block_location(b));
29 mi_le->csum = cpu_to_le32(dm_bm_checksum(&mi_le->padding,
30 block_size - sizeof(__le32),
34 static int index_check(struct dm_block_validator *v,
38 struct disk_metadata_index *mi_le = dm_block_data(b);
41 if (dm_block_location(b) != le64_to_cpu(mi_le->blocknr)) {
42 DMERR_LIMIT("index_check failed: blocknr %llu != wanted %llu",
43 le64_to_cpu(mi_le->blocknr), dm_block_location(b));
47 csum_disk = cpu_to_le32(dm_bm_checksum(&mi_le->padding,
48 block_size - sizeof(__le32),
50 if (csum_disk != mi_le->csum) {
51 DMERR_LIMIT("index_check failed: csum %u != wanted %u",
52 le32_to_cpu(csum_disk), le32_to_cpu(mi_le->csum));
59 static struct dm_block_validator index_validator = {
61 .prepare_for_write = index_prepare_for_write,
65 /*----------------------------------------------------------------*/
70 #define BITMAP_CSUM_XOR 240779
72 static void dm_bitmap_prepare_for_write(struct dm_block_validator *v,
76 struct disk_bitmap_header *disk_header = dm_block_data(b);
78 disk_header->blocknr = cpu_to_le64(dm_block_location(b));
79 disk_header->csum = cpu_to_le32(dm_bm_checksum(&disk_header->not_used,
80 block_size - sizeof(__le32),
84 static int dm_bitmap_check(struct dm_block_validator *v,
88 struct disk_bitmap_header *disk_header = dm_block_data(b);
91 if (dm_block_location(b) != le64_to_cpu(disk_header->blocknr)) {
92 DMERR_LIMIT("bitmap check failed: blocknr %llu != wanted %llu",
93 le64_to_cpu(disk_header->blocknr), dm_block_location(b));
97 csum_disk = cpu_to_le32(dm_bm_checksum(&disk_header->not_used,
98 block_size - sizeof(__le32),
100 if (csum_disk != disk_header->csum) {
101 DMERR_LIMIT("bitmap check failed: csum %u != wanted %u",
102 le32_to_cpu(csum_disk), le32_to_cpu(disk_header->csum));
109 static struct dm_block_validator dm_sm_bitmap_validator = {
111 .prepare_for_write = dm_bitmap_prepare_for_write,
112 .check = dm_bitmap_check,
115 /*----------------------------------------------------------------*/
117 #define ENTRIES_PER_WORD 32
118 #define ENTRIES_SHIFT 5
120 static void *dm_bitmap_data(struct dm_block *b)
122 return dm_block_data(b) + sizeof(struct disk_bitmap_header);
125 #define WORD_MASK_HIGH 0xAAAAAAAAAAAAAAAAULL
127 static unsigned dm_bitmap_word_used(void *addr, unsigned b)
129 __le64 *words_le = addr;
130 __le64 *w_le = words_le + (b >> ENTRIES_SHIFT);
132 uint64_t bits = le64_to_cpu(*w_le);
133 uint64_t mask = (bits + WORD_MASK_HIGH + 1) & WORD_MASK_HIGH;
135 return !(~bits & mask);
138 static unsigned sm_lookup_bitmap(void *addr, unsigned b)
140 __le64 *words_le = addr;
141 __le64 *w_le = words_le + (b >> ENTRIES_SHIFT);
144 b = (b & (ENTRIES_PER_WORD - 1)) << 1;
145 hi = !!test_bit_le(b, (void *) w_le);
146 lo = !!test_bit_le(b + 1, (void *) w_le);
147 return (hi << 1) | lo;
150 static void sm_set_bitmap(void *addr, unsigned b, unsigned val)
152 __le64 *words_le = addr;
153 __le64 *w_le = words_le + (b >> ENTRIES_SHIFT);
155 b = (b & (ENTRIES_PER_WORD - 1)) << 1;
158 __set_bit_le(b, (void *) w_le);
160 __clear_bit_le(b, (void *) w_le);
163 __set_bit_le(b + 1, (void *) w_le);
165 __clear_bit_le(b + 1, (void *) w_le);
168 static int sm_find_free(void *addr, unsigned begin, unsigned end,
171 while (begin < end) {
172 if (!(begin & (ENTRIES_PER_WORD - 1)) &&
173 dm_bitmap_word_used(addr, begin)) {
174 begin += ENTRIES_PER_WORD;
178 if (!sm_lookup_bitmap(addr, begin)) {
189 /*----------------------------------------------------------------*/
191 static int sm_ll_init(struct ll_disk *ll, struct dm_transaction_manager *tm)
193 memset(ll, 0, sizeof(struct ll_disk));
197 ll->bitmap_info.tm = tm;
198 ll->bitmap_info.levels = 1;
201 * Because the new bitmap blocks are created via a shadow
202 * operation, the old entry has already had its reference count
203 * decremented and we don't need the btree to do any bookkeeping.
205 ll->bitmap_info.value_type.size = sizeof(struct disk_index_entry);
206 ll->bitmap_info.value_type.inc = NULL;
207 ll->bitmap_info.value_type.dec = NULL;
208 ll->bitmap_info.value_type.equal = NULL;
210 ll->ref_count_info.tm = tm;
211 ll->ref_count_info.levels = 1;
212 ll->ref_count_info.value_type.size = sizeof(uint32_t);
213 ll->ref_count_info.value_type.inc = NULL;
214 ll->ref_count_info.value_type.dec = NULL;
215 ll->ref_count_info.value_type.equal = NULL;
217 ll->block_size = dm_bm_block_size(dm_tm_get_bm(tm));
219 if (ll->block_size > (1 << 30)) {
220 DMERR("block size too big to hold bitmaps");
224 ll->entries_per_block = (ll->block_size - sizeof(struct disk_bitmap_header)) *
228 ll->ref_count_root = 0;
229 ll->bitmap_index_changed = false;
234 int sm_ll_extend(struct ll_disk *ll, dm_block_t extra_blocks)
237 dm_block_t i, nr_blocks, nr_indexes;
238 unsigned old_blocks, blocks;
240 nr_blocks = ll->nr_blocks + extra_blocks;
241 old_blocks = dm_sector_div_up(ll->nr_blocks, ll->entries_per_block);
242 blocks = dm_sector_div_up(nr_blocks, ll->entries_per_block);
244 nr_indexes = dm_sector_div_up(nr_blocks, ll->entries_per_block);
245 if (nr_indexes > ll->max_entries(ll)) {
246 DMERR("space map too large");
251 * We need to set this before the dm_tm_new_block() call below.
253 ll->nr_blocks = nr_blocks;
254 for (i = old_blocks; i < blocks; i++) {
256 struct disk_index_entry idx;
258 r = dm_tm_new_block(ll->tm, &dm_sm_bitmap_validator, &b);
262 idx.blocknr = cpu_to_le64(dm_block_location(b));
264 dm_tm_unlock(ll->tm, b);
266 idx.nr_free = cpu_to_le32(ll->entries_per_block);
267 idx.none_free_before = 0;
269 r = ll->save_ie(ll, i, &idx);
277 int sm_ll_lookup_bitmap(struct ll_disk *ll, dm_block_t b, uint32_t *result)
280 dm_block_t index = b;
281 struct disk_index_entry ie_disk;
282 struct dm_block *blk;
284 if (b >= ll->nr_blocks) {
285 DMERR_LIMIT("metadata block out of bounds");
289 b = do_div(index, ll->entries_per_block);
290 r = ll->load_ie(ll, index, &ie_disk);
294 r = dm_tm_read_lock(ll->tm, le64_to_cpu(ie_disk.blocknr),
295 &dm_sm_bitmap_validator, &blk);
299 *result = sm_lookup_bitmap(dm_bitmap_data(blk), b);
301 dm_tm_unlock(ll->tm, blk);
306 static int sm_ll_lookup_big_ref_count(struct ll_disk *ll, dm_block_t b,
312 r = dm_btree_lookup(&ll->ref_count_info, ll->ref_count_root, &b, &le_rc);
316 *result = le32_to_cpu(le_rc);
321 int sm_ll_lookup(struct ll_disk *ll, dm_block_t b, uint32_t *result)
323 int r = sm_ll_lookup_bitmap(ll, b, result);
331 return sm_ll_lookup_big_ref_count(ll, b, result);
334 int sm_ll_find_free_block(struct ll_disk *ll, dm_block_t begin,
335 dm_block_t end, dm_block_t *result)
338 struct disk_index_entry ie_disk;
339 dm_block_t i, index_begin = begin;
340 dm_block_t index_end = dm_sector_div_up(end, ll->entries_per_block);
345 begin = do_div(index_begin, ll->entries_per_block);
346 end = do_div(end, ll->entries_per_block);
348 end = ll->entries_per_block;
350 for (i = index_begin; i < index_end; i++, begin = 0) {
351 struct dm_block *blk;
355 r = ll->load_ie(ll, i, &ie_disk);
359 if (le32_to_cpu(ie_disk.nr_free) == 0)
362 r = dm_tm_read_lock(ll->tm, le64_to_cpu(ie_disk.blocknr),
363 &dm_sm_bitmap_validator, &blk);
367 bit_end = (i == index_end - 1) ? end : ll->entries_per_block;
369 r = sm_find_free(dm_bitmap_data(blk),
370 max_t(unsigned, begin, le32_to_cpu(ie_disk.none_free_before)),
374 * This might happen because we started searching
375 * part way through the bitmap.
377 dm_tm_unlock(ll->tm, blk);
381 dm_tm_unlock(ll->tm, blk);
383 *result = i * ll->entries_per_block + (dm_block_t) position;
390 int sm_ll_find_common_free_block(struct ll_disk *old_ll, struct ll_disk *new_ll,
391 dm_block_t begin, dm_block_t end, dm_block_t *b)
397 r = sm_ll_find_free_block(new_ll, begin, new_ll->nr_blocks, b);
401 /* double check this block wasn't used in the old transaction */
402 if (*b >= old_ll->nr_blocks)
405 r = sm_ll_lookup(old_ll, *b, &count);
417 static int sm_ll_mutate(struct ll_disk *ll, dm_block_t b,
418 int (*mutator)(void *context, uint32_t old, uint32_t *new),
419 void *context, enum allocation_event *ev)
422 uint32_t bit, old, ref_count;
424 dm_block_t index = b;
425 struct disk_index_entry ie_disk;
429 bit = do_div(index, ll->entries_per_block);
430 r = ll->load_ie(ll, index, &ie_disk);
434 r = dm_tm_shadow_block(ll->tm, le64_to_cpu(ie_disk.blocknr),
435 &dm_sm_bitmap_validator, &nb, &inc);
437 DMERR("dm_tm_shadow_block() failed");
440 ie_disk.blocknr = cpu_to_le64(dm_block_location(nb));
442 bm_le = dm_bitmap_data(nb);
443 old = sm_lookup_bitmap(bm_le, bit);
446 r = sm_ll_lookup_big_ref_count(ll, b, &old);
448 dm_tm_unlock(ll->tm, nb);
453 r = mutator(context, old, &ref_count);
455 dm_tm_unlock(ll->tm, nb);
459 if (ref_count <= 2) {
460 sm_set_bitmap(bm_le, bit, ref_count);
462 dm_tm_unlock(ll->tm, nb);
465 r = dm_btree_remove(&ll->ref_count_info,
467 &b, &ll->ref_count_root);
473 __le32 le_rc = cpu_to_le32(ref_count);
475 sm_set_bitmap(bm_le, bit, 3);
476 dm_tm_unlock(ll->tm, nb);
478 __dm_bless_for_disk(&le_rc);
479 r = dm_btree_insert(&ll->ref_count_info, ll->ref_count_root,
480 &b, &le_rc, &ll->ref_count_root);
482 DMERR("ref count insert failed");
487 if (ref_count && !old) {
490 le32_add_cpu(&ie_disk.nr_free, -1);
491 if (le32_to_cpu(ie_disk.none_free_before) == bit)
492 ie_disk.none_free_before = cpu_to_le32(bit + 1);
494 } else if (old && !ref_count) {
497 le32_add_cpu(&ie_disk.nr_free, 1);
498 ie_disk.none_free_before = cpu_to_le32(min(le32_to_cpu(ie_disk.none_free_before), bit));
502 return ll->save_ie(ll, index, &ie_disk);
505 static int set_ref_count(void *context, uint32_t old, uint32_t *new)
507 *new = *((uint32_t *) context);
511 int sm_ll_insert(struct ll_disk *ll, dm_block_t b,
512 uint32_t ref_count, enum allocation_event *ev)
514 return sm_ll_mutate(ll, b, set_ref_count, &ref_count, ev);
517 static int inc_ref_count(void *context, uint32_t old, uint32_t *new)
523 int sm_ll_inc(struct ll_disk *ll, dm_block_t b, enum allocation_event *ev)
525 return sm_ll_mutate(ll, b, inc_ref_count, NULL, ev);
528 static int dec_ref_count(void *context, uint32_t old, uint32_t *new)
531 DMERR_LIMIT("unable to decrement a reference count below 0");
539 int sm_ll_dec(struct ll_disk *ll, dm_block_t b, enum allocation_event *ev)
541 return sm_ll_mutate(ll, b, dec_ref_count, NULL, ev);
544 int sm_ll_commit(struct ll_disk *ll)
548 if (ll->bitmap_index_changed) {
551 ll->bitmap_index_changed = false;
557 /*----------------------------------------------------------------*/
559 static int metadata_ll_load_ie(struct ll_disk *ll, dm_block_t index,
560 struct disk_index_entry *ie)
562 memcpy(ie, ll->mi_le.index + index, sizeof(*ie));
566 static int metadata_ll_save_ie(struct ll_disk *ll, dm_block_t index,
567 struct disk_index_entry *ie)
569 ll->bitmap_index_changed = true;
570 memcpy(ll->mi_le.index + index, ie, sizeof(*ie));
574 static int metadata_ll_init_index(struct ll_disk *ll)
579 r = dm_tm_new_block(ll->tm, &index_validator, &b);
583 ll->bitmap_root = dm_block_location(b);
585 dm_tm_unlock(ll->tm, b);
590 static int metadata_ll_open(struct ll_disk *ll)
593 struct dm_block *block;
595 r = dm_tm_read_lock(ll->tm, ll->bitmap_root,
596 &index_validator, &block);
600 memcpy(&ll->mi_le, dm_block_data(block), sizeof(ll->mi_le));
601 dm_tm_unlock(ll->tm, block);
606 static dm_block_t metadata_ll_max_entries(struct ll_disk *ll)
608 return MAX_METADATA_BITMAPS;
611 static int metadata_ll_commit(struct ll_disk *ll)
616 r = dm_tm_shadow_block(ll->tm, ll->bitmap_root, &index_validator, &b, &inc);
620 memcpy(dm_block_data(b), &ll->mi_le, sizeof(ll->mi_le));
621 ll->bitmap_root = dm_block_location(b);
623 dm_tm_unlock(ll->tm, b);
628 int sm_ll_new_metadata(struct ll_disk *ll, struct dm_transaction_manager *tm)
632 r = sm_ll_init(ll, tm);
636 ll->load_ie = metadata_ll_load_ie;
637 ll->save_ie = metadata_ll_save_ie;
638 ll->init_index = metadata_ll_init_index;
639 ll->open_index = metadata_ll_open;
640 ll->max_entries = metadata_ll_max_entries;
641 ll->commit = metadata_ll_commit;
644 ll->nr_allocated = 0;
646 r = ll->init_index(ll);
650 r = dm_btree_empty(&ll->ref_count_info, &ll->ref_count_root);
657 int sm_ll_open_metadata(struct ll_disk *ll, struct dm_transaction_manager *tm,
658 void *root_le, size_t len)
661 struct disk_sm_root smr;
663 if (len < sizeof(struct disk_sm_root)) {
664 DMERR("sm_metadata root too small");
669 * We don't know the alignment of the root_le buffer, so need to
670 * copy into a new structure.
672 memcpy(&smr, root_le, sizeof(smr));
674 r = sm_ll_init(ll, tm);
678 ll->load_ie = metadata_ll_load_ie;
679 ll->save_ie = metadata_ll_save_ie;
680 ll->init_index = metadata_ll_init_index;
681 ll->open_index = metadata_ll_open;
682 ll->max_entries = metadata_ll_max_entries;
683 ll->commit = metadata_ll_commit;
685 ll->nr_blocks = le64_to_cpu(smr.nr_blocks);
686 ll->nr_allocated = le64_to_cpu(smr.nr_allocated);
687 ll->bitmap_root = le64_to_cpu(smr.bitmap_root);
688 ll->ref_count_root = le64_to_cpu(smr.ref_count_root);
690 return ll->open_index(ll);
693 /*----------------------------------------------------------------*/
695 static int disk_ll_load_ie(struct ll_disk *ll, dm_block_t index,
696 struct disk_index_entry *ie)
698 return dm_btree_lookup(&ll->bitmap_info, ll->bitmap_root, &index, ie);
701 static int disk_ll_save_ie(struct ll_disk *ll, dm_block_t index,
702 struct disk_index_entry *ie)
704 __dm_bless_for_disk(ie);
705 return dm_btree_insert(&ll->bitmap_info, ll->bitmap_root,
706 &index, ie, &ll->bitmap_root);
709 static int disk_ll_init_index(struct ll_disk *ll)
711 return dm_btree_empty(&ll->bitmap_info, &ll->bitmap_root);
714 static int disk_ll_open(struct ll_disk *ll)
720 static dm_block_t disk_ll_max_entries(struct ll_disk *ll)
725 static int disk_ll_commit(struct ll_disk *ll)
730 int sm_ll_new_disk(struct ll_disk *ll, struct dm_transaction_manager *tm)
734 r = sm_ll_init(ll, tm);
738 ll->load_ie = disk_ll_load_ie;
739 ll->save_ie = disk_ll_save_ie;
740 ll->init_index = disk_ll_init_index;
741 ll->open_index = disk_ll_open;
742 ll->max_entries = disk_ll_max_entries;
743 ll->commit = disk_ll_commit;
746 ll->nr_allocated = 0;
748 r = ll->init_index(ll);
752 r = dm_btree_empty(&ll->ref_count_info, &ll->ref_count_root);
759 int sm_ll_open_disk(struct ll_disk *ll, struct dm_transaction_manager *tm,
760 void *root_le, size_t len)
763 struct disk_sm_root *smr = root_le;
765 if (len < sizeof(struct disk_sm_root)) {
766 DMERR("sm_metadata root too small");
770 r = sm_ll_init(ll, tm);
774 ll->load_ie = disk_ll_load_ie;
775 ll->save_ie = disk_ll_save_ie;
776 ll->init_index = disk_ll_init_index;
777 ll->open_index = disk_ll_open;
778 ll->max_entries = disk_ll_max_entries;
779 ll->commit = disk_ll_commit;
781 ll->nr_blocks = le64_to_cpu(smr->nr_blocks);
782 ll->nr_allocated = le64_to_cpu(smr->nr_allocated);
783 ll->bitmap_root = le64_to_cpu(smr->bitmap_root);
784 ll->ref_count_root = le64_to_cpu(smr->ref_count_root);
786 return ll->open_index(ll);
789 /*----------------------------------------------------------------*/