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 struct ext4_fs *fs = inode_ref->fs;
236 struct ext4_sblock *sb = &fs->sb;
238 /* Compute indexes */
239 uint32_t bg_first = ext4_balloc_get_bgid_of_block(sb, first);
241 /* Compute indexes */
242 uint32_t bg_last = ext4_balloc_get_bgid_of_block(sb, first + count - 1);
244 if (!ext4_sb_feature_incom(sb, EXT4_FINCOM_FLEX_BG)) {
245 /*It is not possible without flex_bg that blocks are continuous
246 * and and last block belongs to other bg.*/
247 if (bg_last != bg_first) {
248 ext4_dbg(DEBUG_BALLOC, DBG_WARN "FLEX_BG: disabled & "
249 "bg_last: %"PRIu32" bg_first: %"PRIu32"\n",
254 /* Load block group reference */
255 struct ext4_block_group_ref bg_ref;
256 while (bg_first <= bg_last) {
258 rc = ext4_fs_get_block_group_ref(fs, bg_first, &bg_ref);
262 struct ext4_bgroup *bg = bg_ref.block_group;
264 uint32_t idx_in_bg_first;
265 idx_in_bg_first = ext4_fs_addr_to_idx_bg(sb, first);
267 /* Load block with bitmap */
268 ext4_fsblk_t bitmap_blk = ext4_bg_get_block_bitmap(bg, sb);
270 struct ext4_block blk;
271 rc = ext4_trans_block_get(fs->bdev, &blk, bitmap_blk);
273 ext4_fs_put_block_group_ref(&bg_ref);
277 if (!ext4_balloc_verify_bitmap_csum(sb, bg, blk.data)) {
278 ext4_dbg(DEBUG_BALLOC,
279 DBG_WARN "Bitmap checksum failed."
280 "Group: %" PRIu32"\n",
284 free_cnt = ext4_sb_get_block_size(sb) * 8 - idx_in_bg_first;
286 /*If last block, free only count blocks*/
287 free_cnt = count > free_cnt ? free_cnt : count;
290 ext4_bmap_bits_free(blk.data, idx_in_bg_first, free_cnt);
291 ext4_balloc_set_bitmap_csum(sb, bg, blk.data);
292 ext4_trans_set_block_dirty(blk.buf);
297 /* Release block with bitmap */
298 rc = ext4_block_set(fs->bdev, &blk);
300 ext4_fs_put_block_group_ref(&bg_ref);
304 uint32_t block_size = ext4_sb_get_block_size(sb);
306 /* Update superblock free blocks count */
307 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
308 sb_free_blocks += free_cnt;
309 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
311 /* Update inode blocks count */
313 ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
314 ino_blocks -= free_cnt * (block_size / EXT4_INODE_BLOCK_SIZE);
315 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
316 inode_ref->dirty = true;
318 /* Update block group free blocks count */
319 uint32_t free_blocks;
320 free_blocks = ext4_bg_get_free_blocks_count(bg, sb);
321 free_blocks += free_cnt;
322 ext4_bg_set_free_blocks_count(bg, sb, free_blocks);
325 /* Release block group reference */
326 rc = ext4_fs_put_block_group_ref(&bg_ref);
334 for (i = 0;i < count;i++) {
335 rc = ext4_trans_try_revoke_block(fs->bdev, first + i);
341 ext4_bcache_invalidate_lba(fs->bdev->bc, first, count);
342 /*All blocks should be released*/
343 ext4_assert(count == 0);
347 int ext4_balloc_alloc_block(struct ext4_inode_ref *inode_ref,
349 ext4_fsblk_t *fblock)
351 ext4_fsblk_t alloc = 0;
352 ext4_fsblk_t bmp_blk_adr;
353 uint32_t rel_blk_idx = 0;
354 uint64_t free_blocks;
356 struct ext4_sblock *sb = &inode_ref->fs->sb;
358 /* Load block group number for goal and relative index */
359 uint32_t bg_id = ext4_balloc_get_bgid_of_block(sb, goal);
360 uint32_t idx_in_bg = ext4_fs_addr_to_idx_bg(sb, goal);
363 struct ext4_block_group_ref bg_ref;
365 /* Load block group reference */
366 r = ext4_fs_get_block_group_ref(inode_ref->fs, bg_id, &bg_ref);
370 struct ext4_bgroup *bg = bg_ref.block_group;
372 free_blocks = ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
373 if (free_blocks == 0) {
374 /* This group has no free blocks */
378 /* Compute indexes */
379 ext4_fsblk_t first_in_bg;
380 first_in_bg = ext4_balloc_get_block_of_bgid(sb, bg_ref.index);
382 uint32_t first_in_bg_index;
383 first_in_bg_index = ext4_fs_addr_to_idx_bg(sb, first_in_bg);
385 if (idx_in_bg < first_in_bg_index)
386 idx_in_bg = first_in_bg_index;
388 /* Load block with bitmap */
389 bmp_blk_adr = ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
391 r = ext4_trans_block_get(inode_ref->fs->bdev, &b, bmp_blk_adr);
393 ext4_fs_put_block_group_ref(&bg_ref);
397 if (!ext4_balloc_verify_bitmap_csum(sb, bg, b.data)) {
398 ext4_dbg(DEBUG_BALLOC,
399 DBG_WARN "Bitmap checksum failed."
400 "Group: %" PRIu32"\n",
404 /* Check if goal is free */
405 if (ext4_bmap_is_bit_clr(b.data, idx_in_bg)) {
406 ext4_bmap_bit_set(b.data, idx_in_bg);
407 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
409 ext4_trans_set_block_dirty(b.buf);
410 r = ext4_block_set(inode_ref->fs->bdev, &b);
412 ext4_fs_put_block_group_ref(&bg_ref);
416 alloc = ext4_fs_bg_idx_to_addr(sb, idx_in_bg, bg_id);
420 uint32_t blk_in_bg = ext4_blocks_in_group_cnt(sb, bg_id);
422 uint32_t end_idx = (idx_in_bg + 63) & ~63;
423 if (end_idx > blk_in_bg)
426 /* Try to find free block near to goal */
428 for (tmp_idx = idx_in_bg + 1; tmp_idx < end_idx; ++tmp_idx) {
429 if (ext4_bmap_is_bit_clr(b.data, tmp_idx)) {
430 ext4_bmap_bit_set(b.data, tmp_idx);
432 ext4_balloc_set_bitmap_csum(sb, bg, b.data);
433 ext4_trans_set_block_dirty(b.buf);
434 r = ext4_block_set(inode_ref->fs->bdev, &b);
438 alloc = ext4_fs_bg_idx_to_addr(sb, tmp_idx, bg_id);
443 /* Find free bit in bitmap */
444 r = ext4_bmap_bit_find_clr(b.data, idx_in_bg, blk_in_bg, &rel_blk_idx);
446 ext4_bmap_bit_set(b.data, rel_blk_idx);
447 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group, b.data);
448 ext4_trans_set_block_dirty(b.buf);
449 r = ext4_block_set(inode_ref->fs->bdev, &b);
453 alloc = ext4_fs_bg_idx_to_addr(sb, rel_blk_idx, bg_id);
457 /* No free block found yet */
458 r = ext4_block_set(inode_ref->fs->bdev, &b);
460 ext4_fs_put_block_group_ref(&bg_ref);
466 r = ext4_fs_put_block_group_ref(&bg_ref);
470 /* Try other block groups */
471 uint32_t block_group_count = ext4_block_group_cnt(sb);
472 uint32_t bgid = (bg_id + 1) % block_group_count;
473 uint32_t count = block_group_count;
476 r = ext4_fs_get_block_group_ref(inode_ref->fs, bgid, &bg_ref);
480 struct ext4_bgroup *bg = bg_ref.block_group;
481 free_blocks = ext4_bg_get_free_blocks_count(bg, sb);
482 if (free_blocks == 0) {
483 /* This group has no free blocks */
487 /* Load block with bitmap */
488 bmp_blk_adr = ext4_bg_get_block_bitmap(bg, sb);
489 r = ext4_trans_block_get(inode_ref->fs->bdev, &b, bmp_blk_adr);
491 ext4_fs_put_block_group_ref(&bg_ref);
495 if (!ext4_balloc_verify_bitmap_csum(sb, bg, b.data)) {
496 ext4_dbg(DEBUG_BALLOC,
497 DBG_WARN "Bitmap checksum failed."
498 "Group: %" PRIu32"\n",
502 /* Compute indexes */
503 first_in_bg = ext4_balloc_get_block_of_bgid(sb, bgid);
504 idx_in_bg = ext4_fs_addr_to_idx_bg(sb, first_in_bg);
505 blk_in_bg = ext4_blocks_in_group_cnt(sb, bgid);
506 first_in_bg_index = ext4_fs_addr_to_idx_bg(sb, first_in_bg);
508 if (idx_in_bg < first_in_bg_index)
509 idx_in_bg = first_in_bg_index;
511 r = ext4_bmap_bit_find_clr(b.data, idx_in_bg, blk_in_bg,
514 ext4_bmap_bit_set(b.data, rel_blk_idx);
515 ext4_balloc_set_bitmap_csum(sb, bg, b.data);
516 ext4_trans_set_block_dirty(b.buf);
517 r = ext4_block_set(inode_ref->fs->bdev, &b);
519 ext4_fs_put_block_group_ref(&bg_ref);
523 alloc = ext4_fs_bg_idx_to_addr(sb, rel_blk_idx, bgid);
527 r = ext4_block_set(inode_ref->fs->bdev, &b);
529 ext4_fs_put_block_group_ref(&bg_ref);
534 r = ext4_fs_put_block_group_ref(&bg_ref);
539 /* Goto next group */
540 bgid = (bgid + 1) % block_group_count;
547 /* Empty command - because of syntax */
550 uint32_t block_size = ext4_sb_get_block_size(sb);
552 /* Update superblock free blocks count */
553 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
555 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
557 /* Update inode blocks (different block size!) count */
558 uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
559 ino_blocks += block_size / EXT4_INODE_BLOCK_SIZE;
560 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
561 inode_ref->dirty = true;
563 /* Update block group free blocks count */
565 uint32_t fb_cnt = ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
567 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, fb_cnt);
570 r = ext4_fs_put_block_group_ref(&bg_ref);
576 int ext4_balloc_try_alloc_block(struct ext4_inode_ref *inode_ref,
577 ext4_fsblk_t baddr, bool *free)
581 struct ext4_fs *fs = inode_ref->fs;
582 struct ext4_sblock *sb = &fs->sb;
584 /* Compute indexes */
585 uint32_t block_group = ext4_balloc_get_bgid_of_block(sb, baddr);
586 uint32_t index_in_group = ext4_fs_addr_to_idx_bg(sb, baddr);
588 /* Load block group reference */
589 struct ext4_block_group_ref bg_ref;
590 rc = ext4_fs_get_block_group_ref(fs, block_group, &bg_ref);
594 /* Load block with bitmap */
595 ext4_fsblk_t bmp_blk_addr;
596 bmp_blk_addr = ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
599 rc = ext4_trans_block_get(fs->bdev, &b, bmp_blk_addr);
601 ext4_fs_put_block_group_ref(&bg_ref);
605 if (!ext4_balloc_verify_bitmap_csum(sb, bg_ref.block_group, b.data)) {
606 ext4_dbg(DEBUG_BALLOC,
607 DBG_WARN "Bitmap checksum failed."
608 "Group: %" PRIu32"\n",
612 /* Check if block is free */
613 *free = ext4_bmap_is_bit_clr(b.data, index_in_group);
615 /* Allocate block if possible */
617 ext4_bmap_bit_set(b.data, index_in_group);
618 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group, b.data);
619 ext4_trans_set_block_dirty(b.buf);
622 /* Release block with bitmap */
623 rc = ext4_block_set(fs->bdev, &b);
625 /* Error in saving bitmap */
626 ext4_fs_put_block_group_ref(&bg_ref);
630 /* If block is not free, return */
634 uint32_t block_size = ext4_sb_get_block_size(sb);
636 /* Update superblock free blocks count */
637 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
639 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
641 /* Update inode blocks count */
642 uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
643 ino_blocks += block_size / EXT4_INODE_BLOCK_SIZE;
644 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
645 inode_ref->dirty = true;
647 /* Update block group free blocks count */
648 uint32_t fb_cnt = ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
650 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, fb_cnt);
655 return ext4_fs_put_block_group_ref(&bg_ref);