2 * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)
5 * Copyright (c) 2012 Martin Sucha
6 * Copyright (c) 2012 Frantisek Princ
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * - Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * - Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * - The name of the author may not be used to endorse or promote products
19 * derived from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 /** @addtogroup lwext4
38 * @brief Physical block allocator.
41 #include "ext4_config.h"
42 #include "ext4_types.h"
43 #include "ext4_misc.h"
44 #include "ext4_errno.h"
45 #include "ext4_debug.h"
47 #include "ext4_trans.h"
48 #include "ext4_balloc.h"
49 #include "ext4_super.h"
50 #include "ext4_crc32.h"
51 #include "ext4_block_group.h"
53 #include "ext4_bitmap.h"
54 #include "ext4_inode.h"
56 /**@brief Compute number of block group from block address.
57 * @param sb superblock pointer.
58 * @param baddr Absolute address of block.
59 * @return Block group index
61 uint32_t ext4_balloc_get_bgid_of_block(struct ext4_sblock *s,
64 if (ext4_get32(s, first_data_block) && baddr)
67 return (uint32_t)(baddr / ext4_get32(s, blocks_per_group));
70 /**@brief Compute the starting block address of a block group
71 * @param sb superblock pointer.
72 * @param bgid block group index
73 * @return Block address
75 uint64_t ext4_balloc_get_block_of_bgid(struct ext4_sblock *s,
79 if (ext4_get32(s, first_data_block))
82 baddr += bgid * ext4_get32(s, blocks_per_group);
86 #if CONFIG_META_CSUM_ENABLE
87 static uint32_t ext4_balloc_bitmap_csum(struct ext4_sblock *sb,
90 uint32_t checksum = 0;
91 if (ext4_sb_feature_ro_com(sb, EXT4_FRO_COM_METADATA_CSUM)) {
92 uint32_t blocks_per_group = ext4_get32(sb, blocks_per_group);
94 /* First calculate crc32 checksum against fs uuid */
95 checksum = ext4_crc32c(EXT4_CRC32_INIT, sb->uuid,
97 /* Then calculate crc32 checksum against block_group_desc */
98 checksum = ext4_crc32c(checksum, bitmap, blocks_per_group / 8);
103 #define ext4_balloc_bitmap_csum(...) 0
106 void ext4_balloc_set_bitmap_csum(struct ext4_sblock *sb,
107 struct ext4_bgroup *bg,
108 void *bitmap __unused)
110 int desc_size = ext4_sb_get_desc_size(sb);
111 uint32_t checksum = ext4_balloc_bitmap_csum(sb, bitmap);
112 uint16_t lo_checksum = to_le16(checksum & 0xFFFF),
113 hi_checksum = to_le16(checksum >> 16);
115 if (!ext4_sb_feature_ro_com(sb, EXT4_FRO_COM_METADATA_CSUM))
118 /* See if we need to assign a 32bit checksum */
119 bg->block_bitmap_csum_lo = lo_checksum;
120 if (desc_size == EXT4_MAX_BLOCK_GROUP_DESCRIPTOR_SIZE)
121 bg->block_bitmap_csum_hi = hi_checksum;
125 #if CONFIG_META_CSUM_ENABLE
127 ext4_balloc_verify_bitmap_csum(struct ext4_sblock *sb,
128 struct ext4_bgroup *bg,
129 void *bitmap __unused)
131 int desc_size = ext4_sb_get_desc_size(sb);
132 uint32_t checksum = ext4_balloc_bitmap_csum(sb, bitmap);
133 uint16_t lo_checksum = to_le16(checksum & 0xFFFF),
134 hi_checksum = to_le16(checksum >> 16);
136 if (!ext4_sb_feature_ro_com(sb, EXT4_FRO_COM_METADATA_CSUM))
139 if (bg->block_bitmap_csum_lo != lo_checksum)
142 if (desc_size == EXT4_MAX_BLOCK_GROUP_DESCRIPTOR_SIZE)
143 if (bg->block_bitmap_csum_hi != hi_checksum)
149 #define ext4_balloc_verify_bitmap_csum(...) true
152 int ext4_balloc_free_block(struct ext4_inode_ref *inode_ref, ext4_fsblk_t baddr)
154 struct ext4_fs *fs = inode_ref->fs;
155 struct ext4_sblock *sb = &fs->sb;
157 uint32_t bg_id = ext4_balloc_get_bgid_of_block(sb, baddr);
158 uint32_t index_in_group = ext4_fs_addr_to_idx_bg(sb, baddr);
160 /* Load block group reference */
161 struct ext4_block_group_ref bg_ref;
162 int rc = ext4_fs_get_block_group_ref(fs, bg_id, &bg_ref);
166 struct ext4_bgroup *bg = bg_ref.block_group;
168 /* Load block with bitmap */
169 ext4_fsblk_t bitmap_block_addr =
170 ext4_bg_get_block_bitmap(bg, sb);
172 struct ext4_block bitmap_block;
174 rc = ext4_trans_block_get(fs->bdev, &bitmap_block, bitmap_block_addr);
176 ext4_fs_put_block_group_ref(&bg_ref);
180 if (!ext4_balloc_verify_bitmap_csum(sb, bg, bitmap_block.data)) {
181 ext4_dbg(DEBUG_BALLOC,
182 DBG_WARN "Bitmap checksum failed."
183 "Group: %" PRIu32"\n",
188 ext4_bmap_bit_clr(bitmap_block.data, index_in_group);
189 ext4_balloc_set_bitmap_csum(sb, bg, bitmap_block.data);
190 ext4_trans_set_block_dirty(bitmap_block.buf);
192 /* Release block with bitmap */
193 rc = ext4_block_set(fs->bdev, &bitmap_block);
195 /* Error in saving bitmap */
196 ext4_fs_put_block_group_ref(&bg_ref);
200 uint32_t block_size = ext4_sb_get_block_size(sb);
202 /* Update superblock free blocks count */
203 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
205 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
207 /* Update inode blocks count */
208 uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
209 ino_blocks -= block_size / EXT4_INODE_BLOCK_SIZE;
210 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
211 inode_ref->dirty = true;
213 /* Update block group free blocks count */
214 uint32_t free_blocks = ext4_bg_get_free_blocks_count(bg, sb);
216 ext4_bg_set_free_blocks_count(bg, sb, free_blocks);
220 rc = ext4_trans_try_revoke_block(fs->bdev, baddr);
222 bg_ref.dirty = false;
223 ext4_fs_put_block_group_ref(&bg_ref);
226 ext4_bcache_invalidate_lba(fs->bdev->bc, baddr, 1);
227 /* Release block group reference */
228 return ext4_fs_put_block_group_ref(&bg_ref);
231 int ext4_balloc_free_blocks(struct ext4_inode_ref *inode_ref,
232 ext4_fsblk_t first, uint32_t count)
235 uint32_t blk_cnt = count;
236 struct ext4_fs *fs = inode_ref->fs;
237 struct ext4_sblock *sb = &fs->sb;
239 /* Compute indexes */
240 uint32_t bg_first = ext4_balloc_get_bgid_of_block(sb, first);
242 /* Compute indexes */
243 uint32_t bg_last = ext4_balloc_get_bgid_of_block(sb, first + count - 1);
245 if (!ext4_sb_feature_incom(sb, EXT4_FINCOM_FLEX_BG)) {
246 /*It is not possible without flex_bg that blocks are continuous
247 * and and last block belongs to other bg.*/
248 if (bg_last != bg_first) {
249 ext4_dbg(DEBUG_BALLOC, DBG_WARN "FLEX_BG: disabled & "
250 "bg_last: %"PRIu32" bg_first: %"PRIu32"\n",
255 /* Load block group reference */
256 struct ext4_block_group_ref bg_ref;
257 while (bg_first <= bg_last) {
259 rc = ext4_fs_get_block_group_ref(fs, bg_first, &bg_ref);
263 struct ext4_bgroup *bg = bg_ref.block_group;
265 uint32_t idx_in_bg_first;
266 idx_in_bg_first = ext4_fs_addr_to_idx_bg(sb, first);
268 /* Load block with bitmap */
269 ext4_fsblk_t bitmap_blk = ext4_bg_get_block_bitmap(bg, sb);
271 struct ext4_block blk;
272 rc = ext4_trans_block_get(fs->bdev, &blk, bitmap_blk);
274 ext4_fs_put_block_group_ref(&bg_ref);
278 if (!ext4_balloc_verify_bitmap_csum(sb, bg, blk.data)) {
279 ext4_dbg(DEBUG_BALLOC,
280 DBG_WARN "Bitmap checksum failed."
281 "Group: %" PRIu32"\n",
285 free_cnt = ext4_sb_get_block_size(sb) * 8 - idx_in_bg_first;
287 /*If last block, free only count blocks*/
288 free_cnt = count > free_cnt ? free_cnt : count;
291 ext4_bmap_bits_free(blk.data, idx_in_bg_first, free_cnt);
292 ext4_balloc_set_bitmap_csum(sb, bg, blk.data);
293 ext4_trans_set_block_dirty(blk.buf);
298 /* Release block with bitmap */
299 rc = ext4_block_set(fs->bdev, &blk);
301 ext4_fs_put_block_group_ref(&bg_ref);
305 uint32_t block_size = ext4_sb_get_block_size(sb);
307 /* Update superblock free blocks count */
308 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
309 sb_free_blocks += free_cnt;
310 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
312 /* Update inode blocks count */
314 ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
315 ino_blocks -= free_cnt * (block_size / EXT4_INODE_BLOCK_SIZE);
316 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
317 inode_ref->dirty = true;
319 /* Update block group free blocks count */
320 uint32_t free_blocks;
321 free_blocks = ext4_bg_get_free_blocks_count(bg, sb);
322 free_blocks += free_cnt;
323 ext4_bg_set_free_blocks_count(bg, sb, free_blocks);
326 /* Release block group reference */
327 rc = ext4_fs_put_block_group_ref(&bg_ref);
335 for (i = 0;i < blk_cnt;i++) {
336 rc = ext4_trans_try_revoke_block(fs->bdev, first + i);
342 ext4_bcache_invalidate_lba(fs->bdev->bc, first, count);
343 /*All blocks should be released*/
344 ext4_assert(count == 0);
348 int ext4_balloc_alloc_block(struct ext4_inode_ref *inode_ref,
350 ext4_fsblk_t *fblock)
352 ext4_fsblk_t alloc = 0;
353 ext4_fsblk_t bmp_blk_adr;
354 uint32_t rel_blk_idx = 0;
355 uint64_t free_blocks;
357 struct ext4_sblock *sb = &inode_ref->fs->sb;
359 /* Load block group number for goal and relative index */
360 uint32_t bg_id = ext4_balloc_get_bgid_of_block(sb, goal);
361 uint32_t idx_in_bg = ext4_fs_addr_to_idx_bg(sb, goal);
364 struct ext4_block_group_ref bg_ref;
366 /* Load block group reference */
367 r = ext4_fs_get_block_group_ref(inode_ref->fs, bg_id, &bg_ref);
371 struct ext4_bgroup *bg = bg_ref.block_group;
373 free_blocks = ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
374 if (free_blocks == 0) {
375 /* This group has no free blocks */
379 /* Compute indexes */
380 ext4_fsblk_t first_in_bg;
381 first_in_bg = ext4_balloc_get_block_of_bgid(sb, bg_ref.index);
383 uint32_t first_in_bg_index;
384 first_in_bg_index = ext4_fs_addr_to_idx_bg(sb, first_in_bg);
386 if (idx_in_bg < first_in_bg_index)
387 idx_in_bg = first_in_bg_index;
389 /* Load block with bitmap */
390 bmp_blk_adr = ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
392 r = ext4_trans_block_get(inode_ref->fs->bdev, &b, bmp_blk_adr);
394 ext4_fs_put_block_group_ref(&bg_ref);
398 if (!ext4_balloc_verify_bitmap_csum(sb, bg, b.data)) {
399 ext4_dbg(DEBUG_BALLOC,
400 DBG_WARN "Bitmap checksum failed."
401 "Group: %" PRIu32"\n",
405 /* Check if goal is free */
406 if (ext4_bmap_is_bit_clr(b.data, idx_in_bg)) {
407 ext4_bmap_bit_set(b.data, idx_in_bg);
408 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
410 ext4_trans_set_block_dirty(b.buf);
411 r = ext4_block_set(inode_ref->fs->bdev, &b);
413 ext4_fs_put_block_group_ref(&bg_ref);
417 alloc = ext4_fs_bg_idx_to_addr(sb, idx_in_bg, bg_id);
421 uint32_t blk_in_bg = ext4_blocks_in_group_cnt(sb, bg_id);
423 uint32_t end_idx = (idx_in_bg + 63) & ~63;
424 if (end_idx > blk_in_bg)
427 /* Try to find free block near to goal */
429 for (tmp_idx = idx_in_bg + 1; tmp_idx < end_idx; ++tmp_idx) {
430 if (ext4_bmap_is_bit_clr(b.data, tmp_idx)) {
431 ext4_bmap_bit_set(b.data, tmp_idx);
433 ext4_balloc_set_bitmap_csum(sb, bg, b.data);
434 ext4_trans_set_block_dirty(b.buf);
435 r = ext4_block_set(inode_ref->fs->bdev, &b);
439 alloc = ext4_fs_bg_idx_to_addr(sb, tmp_idx, bg_id);
444 /* Find free bit in bitmap */
445 r = ext4_bmap_bit_find_clr(b.data, idx_in_bg, blk_in_bg, &rel_blk_idx);
447 ext4_bmap_bit_set(b.data, rel_blk_idx);
448 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group, b.data);
449 ext4_trans_set_block_dirty(b.buf);
450 r = ext4_block_set(inode_ref->fs->bdev, &b);
454 alloc = ext4_fs_bg_idx_to_addr(sb, rel_blk_idx, bg_id);
458 /* No free block found yet */
459 r = ext4_block_set(inode_ref->fs->bdev, &b);
461 ext4_fs_put_block_group_ref(&bg_ref);
467 r = ext4_fs_put_block_group_ref(&bg_ref);
471 /* Try other block groups */
472 uint32_t block_group_count = ext4_block_group_cnt(sb);
473 uint32_t bgid = (bg_id + 1) % block_group_count;
474 uint32_t count = block_group_count;
477 r = ext4_fs_get_block_group_ref(inode_ref->fs, bgid, &bg_ref);
481 struct ext4_bgroup *bg = bg_ref.block_group;
482 free_blocks = ext4_bg_get_free_blocks_count(bg, sb);
483 if (free_blocks == 0) {
484 /* This group has no free blocks */
488 /* Load block with bitmap */
489 bmp_blk_adr = ext4_bg_get_block_bitmap(bg, sb);
490 r = ext4_trans_block_get(inode_ref->fs->bdev, &b, bmp_blk_adr);
492 ext4_fs_put_block_group_ref(&bg_ref);
496 if (!ext4_balloc_verify_bitmap_csum(sb, bg, b.data)) {
497 ext4_dbg(DEBUG_BALLOC,
498 DBG_WARN "Bitmap checksum failed."
499 "Group: %" PRIu32"\n",
503 /* Compute indexes */
504 first_in_bg = ext4_balloc_get_block_of_bgid(sb, bgid);
505 idx_in_bg = ext4_fs_addr_to_idx_bg(sb, first_in_bg);
506 blk_in_bg = ext4_blocks_in_group_cnt(sb, bgid);
507 first_in_bg_index = ext4_fs_addr_to_idx_bg(sb, first_in_bg);
509 if (idx_in_bg < first_in_bg_index)
510 idx_in_bg = first_in_bg_index;
512 r = ext4_bmap_bit_find_clr(b.data, idx_in_bg, blk_in_bg,
515 ext4_bmap_bit_set(b.data, rel_blk_idx);
516 ext4_balloc_set_bitmap_csum(sb, bg, b.data);
517 ext4_trans_set_block_dirty(b.buf);
518 r = ext4_block_set(inode_ref->fs->bdev, &b);
520 ext4_fs_put_block_group_ref(&bg_ref);
524 alloc = ext4_fs_bg_idx_to_addr(sb, rel_blk_idx, bgid);
528 r = ext4_block_set(inode_ref->fs->bdev, &b);
530 ext4_fs_put_block_group_ref(&bg_ref);
535 r = ext4_fs_put_block_group_ref(&bg_ref);
540 /* Goto next group */
541 bgid = (bgid + 1) % block_group_count;
548 /* Empty command - because of syntax */
551 uint32_t block_size = ext4_sb_get_block_size(sb);
553 /* Update superblock free blocks count */
554 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
556 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
558 /* Update inode blocks (different block size!) count */
559 uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
560 ino_blocks += block_size / EXT4_INODE_BLOCK_SIZE;
561 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
562 inode_ref->dirty = true;
564 /* Update block group free blocks count */
566 uint32_t fb_cnt = ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
568 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, fb_cnt);
571 r = ext4_fs_put_block_group_ref(&bg_ref);
577 int ext4_balloc_try_alloc_block(struct ext4_inode_ref *inode_ref,
578 ext4_fsblk_t baddr, bool *free)
582 struct ext4_fs *fs = inode_ref->fs;
583 struct ext4_sblock *sb = &fs->sb;
585 /* Compute indexes */
586 uint32_t block_group = ext4_balloc_get_bgid_of_block(sb, baddr);
587 uint32_t index_in_group = ext4_fs_addr_to_idx_bg(sb, baddr);
589 /* Load block group reference */
590 struct ext4_block_group_ref bg_ref;
591 rc = ext4_fs_get_block_group_ref(fs, block_group, &bg_ref);
595 /* Load block with bitmap */
596 ext4_fsblk_t bmp_blk_addr;
597 bmp_blk_addr = ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
600 rc = ext4_trans_block_get(fs->bdev, &b, bmp_blk_addr);
602 ext4_fs_put_block_group_ref(&bg_ref);
606 if (!ext4_balloc_verify_bitmap_csum(sb, bg_ref.block_group, b.data)) {
607 ext4_dbg(DEBUG_BALLOC,
608 DBG_WARN "Bitmap checksum failed."
609 "Group: %" PRIu32"\n",
613 /* Check if block is free */
614 *free = ext4_bmap_is_bit_clr(b.data, index_in_group);
616 /* Allocate block if possible */
618 ext4_bmap_bit_set(b.data, index_in_group);
619 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group, b.data);
620 ext4_trans_set_block_dirty(b.buf);
623 /* Release block with bitmap */
624 rc = ext4_block_set(fs->bdev, &b);
626 /* Error in saving bitmap */
627 ext4_fs_put_block_group_ref(&bg_ref);
631 /* If block is not free, return */
635 uint32_t block_size = ext4_sb_get_block_size(sb);
637 /* Update superblock free blocks count */
638 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
640 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
642 /* Update inode blocks count */
643 uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
644 ino_blocks += block_size / EXT4_INODE_BLOCK_SIZE;
645 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
646 inode_ref->dirty = true;
648 /* Update block group free blocks count */
649 uint32_t fb_cnt = ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
651 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, fb_cnt);
656 return ext4_fs_put_block_group_ref(&bg_ref);