2 * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)
6 * Copyright (c) 2012 Martin Sucha
7 * Copyright (c) 2012 Frantisek Princ
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
14 * - Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * - Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * - The name of the author may not be used to endorse or promote products
20 * derived from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 /** @addtogroup lwext4
39 * @brief Physical block allocator.
42 #include "ext4_config.h"
43 #include "ext4_balloc.h"
44 #include "ext4_super.h"
45 #include "ext4_crc32c.h"
46 #include "ext4_block_group.h"
48 #include "ext4_bitmap.h"
49 #include "ext4_inode.h"
51 /**@brief Compute number of block group from block address.
52 * @param sb superblock pointer.
53 * @param baddr Absolute address of block.
54 * @return Block group index
56 uint32_t ext4_balloc_get_bgid_of_block(struct ext4_sblock *s,
59 if (ext4_get32(s, first_data_block) && baddr)
62 return baddr / ext4_get32(s, blocks_per_group);
65 /**@brief Compute the starting block address of a block group
66 * @param sb superblock pointer.
67 * @param bgid block group index
68 * @return Block address
70 uint64_t ext4_balloc_get_block_of_bgid(struct ext4_sblock *s,
74 if (ext4_get32(s, first_data_block))
77 baddr += bgid * ext4_get32(s, blocks_per_group);
81 #if CONFIG_META_CSUM_ENABLE
82 static uint32_t ext4_balloc_bitmap_csum(struct ext4_sblock *sb,
85 uint32_t checksum = 0;
86 if (ext4_sb_feature_ro_com(sb, EXT4_FRO_COM_METADATA_CSUM)) {
87 uint32_t blocks_per_group =
88 ext4_get32(sb, blocks_per_group);
90 /* First calculate crc32 checksum against fs uuid */
91 checksum = ext4_crc32c(EXT4_CRC32_INIT, sb->uuid,
93 /* Then calculate crc32 checksum against block_group_desc */
94 checksum = ext4_crc32c(checksum, bitmap,
95 blocks_per_group / 8);
100 #define ext4_balloc_bitmap_csum(...) 0
103 void ext4_balloc_set_bitmap_csum(struct ext4_sblock *sb,
104 struct ext4_bgroup *bg,
105 void *bitmap __unused)
107 int desc_size = ext4_sb_get_desc_size(sb);
108 uint32_t checksum = ext4_balloc_bitmap_csum(sb, bitmap);
109 uint16_t lo_checksum = to_le16(checksum & 0xFFFF),
110 hi_checksum = to_le16(checksum >> 16);
112 /* See if we need to assign a 32bit checksum */
113 bg->block_bitmap_csum_lo = lo_checksum;
114 if (desc_size == EXT4_MAX_BLOCK_GROUP_DESCRIPTOR_SIZE)
115 bg->block_bitmap_csum_hi = hi_checksum;
119 #if CONFIG_META_CSUM_ENABLE
121 ext4_balloc_verify_bitmap_csum(struct ext4_sblock *sb,
122 struct ext4_bgroup *bg,
123 void *bitmap __unused)
126 if (!ext4_sb_feature_ro_com(sb, EXT4_FRO_COM_METADATA_CSUM))
129 int desc_size = ext4_sb_get_desc_size(sb);
130 uint32_t checksum = ext4_balloc_bitmap_csum(sb, bitmap);
131 uint16_t lo_checksum = to_le16(checksum & 0xFFFF),
132 hi_checksum = to_le16(checksum >> 16);
134 if (bg->block_bitmap_csum_lo != lo_checksum)
137 if (desc_size == EXT4_MAX_BLOCK_GROUP_DESCRIPTOR_SIZE)
138 if (bg->block_bitmap_csum_hi != hi_checksum)
144 #define ext4_balloc_verify_bitmap_csum(...) true
147 int ext4_balloc_free_block(struct ext4_inode_ref *inode_ref, ext4_fsblk_t baddr)
149 struct ext4_fs *fs = inode_ref->fs;
150 struct ext4_sblock *sb = &fs->sb;
152 uint32_t block_group = ext4_balloc_get_bgid_of_block(sb, baddr);
153 uint32_t index_in_group = ext4_fs_baddr2_index_in_group(sb, baddr);
155 /* Load block group reference */
156 struct ext4_block_group_ref bg_ref;
157 int rc = ext4_fs_get_block_group_ref(fs, block_group, &bg_ref);
161 /* Load block with bitmap */
162 ext4_fsblk_t bitmap_block_addr =
163 ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
165 struct ext4_block bitmap_block;
167 rc = ext4_block_get(fs->bdev, &bitmap_block, bitmap_block_addr);
169 ext4_fs_put_block_group_ref(&bg_ref);
173 if (!ext4_balloc_verify_bitmap_csum(sb,
175 bitmap_block.data)) {
176 ext4_dbg(DEBUG_BALLOC,
177 DBG_WARN "Bitmap checksum failed."
178 "Group: %" PRIu32"\n",
183 ext4_bmap_bit_clr(bitmap_block.data, index_in_group);
184 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
186 bitmap_block.dirty = true;
188 /* Release block with bitmap */
189 rc = ext4_block_set(fs->bdev, &bitmap_block);
191 /* Error in saving bitmap */
192 ext4_fs_put_block_group_ref(&bg_ref);
196 uint32_t block_size = ext4_sb_get_block_size(sb);
198 /* Update superblock free blocks count */
199 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
201 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
203 /* Update inode blocks count */
204 uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
205 ino_blocks -= block_size / EXT4_INODE_BLOCK_SIZE;
206 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
207 inode_ref->dirty = true;
209 /* Update block group free blocks count */
210 uint32_t free_blocks =
211 ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
213 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, free_blocks);
217 /* Release block group reference */
218 return ext4_fs_put_block_group_ref(&bg_ref);
221 int ext4_balloc_free_blocks(struct ext4_inode_ref *inode_ref, ext4_fsblk_t first,
225 struct ext4_fs *fs = inode_ref->fs;
226 struct ext4_sblock *sb = &fs->sb;
228 /* Compute indexes */
229 uint32_t block_group_first = ext4_balloc_get_bgid_of_block(sb, first);
231 /* Compute indexes */
232 uint32_t block_group_last =
233 ext4_balloc_get_bgid_of_block(sb, first + count - 1);
235 if (!ext4_sb_feature_incom(sb, EXT4_FINCOM_FLEX_BG)) {
236 /*It is not possible without flex_bg that blocks are continuous
237 * and and last block belongs to other bg.*/
238 ext4_assert(block_group_first == ext4_balloc_get_bgid_of_block(
239 sb, first + count - 1));
242 /* Load block group reference */
243 struct ext4_block_group_ref bg_ref;
244 while (block_group_first <= block_group_last) {
247 ext4_fs_get_block_group_ref(fs, block_group_first, &bg_ref);
251 uint32_t index_in_group_first =
252 ext4_fs_baddr2_index_in_group(sb, first);
254 /* Load block with bitmap */
255 ext4_fsblk_t bitmap_block_addr =
256 ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
258 struct ext4_block bitmap_block;
260 rc = ext4_block_get(fs->bdev, &bitmap_block, bitmap_block_addr);
262 ext4_fs_put_block_group_ref(&bg_ref);
266 if (!ext4_balloc_verify_bitmap_csum(sb,
268 bitmap_block.data)) {
269 ext4_dbg(DEBUG_BALLOC,
270 DBG_WARN "Bitmap checksum failed."
271 "Group: %" PRIu32"\n",
276 ext4_sb_get_block_size(sb) * 8 - index_in_group_first;
278 /*If last block, free only count blocks*/
279 free_cnt = count > free_cnt ? free_cnt : count;
282 ext4_bmap_bits_free(bitmap_block.data, index_in_group_first,
284 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
286 bitmap_block.dirty = true;
291 /* Release block with bitmap */
292 rc = ext4_block_set(fs->bdev, &bitmap_block);
294 ext4_fs_put_block_group_ref(&bg_ref);
298 uint32_t block_size = ext4_sb_get_block_size(sb);
300 /* Update superblock free blocks count */
301 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
302 sb_free_blocks += free_cnt;
303 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
305 /* Update inode blocks count */
306 uint64_t ino_blocks =
307 ext4_inode_get_blocks_count(sb, inode_ref->inode);
308 ino_blocks -= free_cnt * (block_size / EXT4_INODE_BLOCK_SIZE);
309 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
310 inode_ref->dirty = true;
312 /* Update block group free blocks count */
313 uint32_t free_blocks =
314 ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
315 free_blocks += free_cnt;
316 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb,
320 /* Release block group reference */
321 rc = ext4_fs_put_block_group_ref(&bg_ref);
328 /*All blocks should be released*/
329 ext4_assert(count == 0);
333 int ext4_balloc_alloc_block(struct ext4_inode_ref *inode_ref,
335 ext4_fsblk_t *fblock)
337 ext4_fsblk_t allocated_block = 0;
338 ext4_fsblk_t bitmap_block_addr;
339 uint32_t rel_block_idx = 0;
340 uint64_t free_blocks;
341 struct ext4_block bitmap_block;
344 struct ext4_sblock *sb = &inode_ref->fs->sb;
346 /* Load block group number for goal and relative index */
347 uint32_t block_group = ext4_balloc_get_bgid_of_block(sb, goal);
348 uint32_t index_in_group = ext4_fs_baddr2_index_in_group(sb, goal);
350 /* Load block group reference */
351 struct ext4_block_group_ref bg_ref;
352 rc = ext4_fs_get_block_group_ref(inode_ref->fs, block_group, &bg_ref);
356 free_blocks = ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
357 if (free_blocks == 0) {
358 /* This group has no free blocks */
362 /* Compute indexes */
363 ext4_fsblk_t first_in_group = ext4_balloc_get_block_of_bgid(sb, bg_ref.index);
365 uint32_t first_in_group_index =
366 ext4_fs_baddr2_index_in_group(sb, first_in_group);
368 if (index_in_group < first_in_group_index)
369 index_in_group = first_in_group_index;
371 /* Load block with bitmap */
372 bitmap_block_addr = ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
374 rc = ext4_block_get(inode_ref->fs->bdev, &bitmap_block,
377 ext4_fs_put_block_group_ref(&bg_ref);
381 if (!ext4_balloc_verify_bitmap_csum(sb,
383 bitmap_block.data)) {
384 ext4_dbg(DEBUG_BALLOC,
385 DBG_WARN "Bitmap checksum failed."
386 "Group: %" PRIu32"\n",
390 /* Check if goal is free */
391 if (ext4_bmap_is_bit_clr(bitmap_block.data, index_in_group)) {
392 ext4_bmap_bit_set(bitmap_block.data, index_in_group);
393 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
395 bitmap_block.dirty = true;
396 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
398 ext4_fs_put_block_group_ref(&bg_ref);
402 allocated_block = ext4_fs_index_in_group2_baddr(
403 sb, index_in_group, block_group);
408 uint32_t blocks_in_group = ext4_blocks_in_group_cnt(sb, block_group);
410 uint32_t end_idx = (index_in_group + 63) & ~63;
411 if (end_idx > blocks_in_group)
412 end_idx = blocks_in_group;
414 /* Try to find free block near to goal */
416 for (tmp_idx = index_in_group + 1; tmp_idx < end_idx; ++tmp_idx) {
417 if (ext4_bmap_is_bit_clr(bitmap_block.data, tmp_idx)) {
418 ext4_bmap_bit_set(bitmap_block.data, tmp_idx);
420 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
422 bitmap_block.dirty = true;
423 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
427 allocated_block = ext4_fs_index_in_group2_baddr(
428 sb, tmp_idx, block_group);
434 /* Find free bit in bitmap */
435 rc = ext4_bmap_bit_find_clr(bitmap_block.data, index_in_group,
436 blocks_in_group, &rel_block_idx);
438 ext4_bmap_bit_set(bitmap_block.data, rel_block_idx);
439 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
441 bitmap_block.dirty = true;
442 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
446 allocated_block = ext4_fs_index_in_group2_baddr(
447 sb, rel_block_idx, block_group);
452 /* No free block found yet */
453 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
455 ext4_fs_put_block_group_ref(&bg_ref);
461 rc = ext4_fs_put_block_group_ref(&bg_ref);
465 /* Try other block groups */
466 uint32_t block_group_count = ext4_block_group_cnt(sb);
468 uint32_t bgid = (block_group + 1) % block_group_count;
469 uint32_t count = block_group_count;
472 rc = ext4_fs_get_block_group_ref(inode_ref->fs, bgid, &bg_ref);
477 ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
478 if (free_blocks == 0) {
479 /* This group has no free blocks */
483 /* Load block with bitmap */
485 ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
487 rc = ext4_block_get(inode_ref->fs->bdev, &bitmap_block,
491 ext4_fs_put_block_group_ref(&bg_ref);
495 if (!ext4_balloc_verify_bitmap_csum(sb,
497 bitmap_block.data)) {
498 ext4_dbg(DEBUG_BALLOC,
499 DBG_WARN "Bitmap checksum failed."
500 "Group: %" PRIu32"\n",
504 /* Compute indexes */
505 first_in_group = ext4_balloc_get_block_of_bgid(sb, bgid);
507 ext4_fs_baddr2_index_in_group(sb, first_in_group);
508 blocks_in_group = ext4_blocks_in_group_cnt(sb, bgid);
510 first_in_group_index =
511 ext4_fs_baddr2_index_in_group(sb, first_in_group);
513 if (index_in_group < first_in_group_index)
514 index_in_group = first_in_group_index;
516 rc = ext4_bmap_bit_find_clr(bitmap_block.data, index_in_group,
517 blocks_in_group, &rel_block_idx);
521 ext4_bmap_bit_set(bitmap_block.data, rel_block_idx);
523 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
525 bitmap_block.dirty = true;
526 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
528 ext4_fs_put_block_group_ref(&bg_ref);
532 allocated_block = ext4_fs_index_in_group2_baddr(
533 sb, rel_block_idx, bgid);
538 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
540 ext4_fs_put_block_group_ref(&bg_ref);
545 rc = ext4_fs_put_block_group_ref(&bg_ref);
550 /* Goto next group */
551 bgid = (bgid + 1) % block_group_count;
558 /* Empty command - because of syntax */
561 uint32_t block_size = ext4_sb_get_block_size(sb);
563 /* Update superblock free blocks count */
564 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
566 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
568 /* Update inode blocks (different block size!) count */
569 uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
570 ino_blocks += block_size / EXT4_INODE_BLOCK_SIZE;
571 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
572 inode_ref->dirty = true;
574 /* Update block group free blocks count */
575 uint64_t bg_free_blocks =
576 ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
578 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, bg_free_blocks);
582 rc = ext4_fs_put_block_group_ref(&bg_ref);
584 *fblock = allocated_block;
588 int ext4_balloc_try_alloc_block(struct ext4_inode_ref *inode_ref,
589 ext4_fsblk_t baddr, bool *free)
593 struct ext4_fs *fs = inode_ref->fs;
594 struct ext4_sblock *sb = &fs->sb;
596 /* Compute indexes */
597 uint32_t block_group = ext4_balloc_get_bgid_of_block(sb, baddr);
598 uint32_t index_in_group = ext4_fs_baddr2_index_in_group(sb, baddr);
600 /* Load block group reference */
601 struct ext4_block_group_ref bg_ref;
602 rc = ext4_fs_get_block_group_ref(fs, block_group, &bg_ref);
606 /* Load block with bitmap */
607 ext4_fsblk_t bitmap_block_addr =
608 ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
610 struct ext4_block bitmap_block;
612 rc = ext4_block_get(fs->bdev, &bitmap_block, bitmap_block_addr);
614 ext4_fs_put_block_group_ref(&bg_ref);
618 if (!ext4_balloc_verify_bitmap_csum(sb,
620 bitmap_block.data)) {
621 ext4_dbg(DEBUG_BALLOC,
622 DBG_WARN "Bitmap checksum failed."
623 "Group: %" PRIu32"\n",
627 /* Check if block is free */
628 *free = ext4_bmap_is_bit_clr(bitmap_block.data, index_in_group);
630 /* Allocate block if possible */
632 ext4_bmap_bit_set(bitmap_block.data, index_in_group);
633 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
635 bitmap_block.dirty = true;
638 /* Release block with bitmap */
639 rc = ext4_block_set(fs->bdev, &bitmap_block);
641 /* Error in saving bitmap */
642 ext4_fs_put_block_group_ref(&bg_ref);
646 /* If block is not free, return */
650 uint32_t block_size = ext4_sb_get_block_size(sb);
652 /* Update superblock free blocks count */
653 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
655 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
657 /* Update inode blocks count */
658 uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
659 ino_blocks += block_size / EXT4_INODE_BLOCK_SIZE;
660 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
661 inode_ref->dirty = true;
663 /* Update block group free blocks count */
664 uint32_t free_blocks =
665 ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
667 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, free_blocks);
672 return ext4_fs_put_block_group_ref(&bg_ref);