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 rc = ext4_fs_put_block_group_ref(&bg_ref);
233 int ext4_balloc_free_blocks(struct ext4_inode_ref *inode_ref,
234 ext4_fsblk_t first, uint32_t count)
237 uint32_t blk_cnt = count;
238 struct ext4_fs *fs = inode_ref->fs;
239 struct ext4_sblock *sb = &fs->sb;
241 /* Compute indexes */
242 uint32_t bg_first = ext4_balloc_get_bgid_of_block(sb, first);
244 /* Compute indexes */
245 uint32_t bg_last = ext4_balloc_get_bgid_of_block(sb, first + count - 1);
247 if (!ext4_sb_feature_incom(sb, EXT4_FINCOM_FLEX_BG)) {
248 /*It is not possible without flex_bg that blocks are continuous
249 * and and last block belongs to other bg.*/
250 if (bg_last != bg_first) {
251 ext4_dbg(DEBUG_BALLOC, DBG_WARN "FLEX_BG: disabled & "
252 "bg_last: %"PRIu32" bg_first: %"PRIu32"\n",
257 /* Load block group reference */
258 struct ext4_block_group_ref bg_ref;
259 while (bg_first <= bg_last) {
261 rc = ext4_fs_get_block_group_ref(fs, bg_first, &bg_ref);
265 struct ext4_bgroup *bg = bg_ref.block_group;
267 uint32_t idx_in_bg_first;
268 idx_in_bg_first = ext4_fs_addr_to_idx_bg(sb, first);
270 /* Load block with bitmap */
271 ext4_fsblk_t bitmap_blk = ext4_bg_get_block_bitmap(bg, sb);
273 struct ext4_block blk;
274 rc = ext4_trans_block_get(fs->bdev, &blk, bitmap_blk);
276 ext4_fs_put_block_group_ref(&bg_ref);
280 if (!ext4_balloc_verify_bitmap_csum(sb, bg, blk.data)) {
281 ext4_dbg(DEBUG_BALLOC,
282 DBG_WARN "Bitmap checksum failed."
283 "Group: %" PRIu32"\n",
287 free_cnt = ext4_sb_get_block_size(sb) * 8 - idx_in_bg_first;
289 /*If last block, free only count blocks*/
290 free_cnt = count > free_cnt ? free_cnt : count;
293 ext4_bmap_bits_free(blk.data, idx_in_bg_first, free_cnt);
294 ext4_balloc_set_bitmap_csum(sb, bg, blk.data);
295 ext4_trans_set_block_dirty(blk.buf);
300 /* Release block with bitmap */
301 rc = ext4_block_set(fs->bdev, &blk);
303 ext4_fs_put_block_group_ref(&bg_ref);
307 uint32_t block_size = ext4_sb_get_block_size(sb);
309 /* Update superblock free blocks count */
310 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
311 sb_free_blocks += free_cnt;
312 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
314 /* Update inode blocks count */
316 ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
317 ino_blocks -= free_cnt * (block_size / EXT4_INODE_BLOCK_SIZE);
318 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
319 inode_ref->dirty = true;
321 /* Update block group free blocks count */
322 uint32_t free_blocks;
323 free_blocks = ext4_bg_get_free_blocks_count(bg, sb);
324 free_blocks += free_cnt;
325 ext4_bg_set_free_blocks_count(bg, sb, free_blocks);
328 /* Release block group reference */
329 rc = ext4_fs_put_block_group_ref(&bg_ref);
337 for (i = 0;i < blk_cnt;i++) {
338 rc = ext4_trans_try_revoke_block(fs->bdev, first + i);
344 ext4_bcache_invalidate_lba(fs->bdev->bc, first, count);
345 /*All blocks should be released*/
346 ext4_assert(count == 0);
351 int ext4_balloc_alloc_block(struct ext4_inode_ref *inode_ref,
353 ext4_fsblk_t *fblock)
355 ext4_fsblk_t alloc = 0;
356 ext4_fsblk_t bmp_blk_adr;
357 uint32_t rel_blk_idx = 0;
358 uint64_t free_blocks;
360 struct ext4_sblock *sb = &inode_ref->fs->sb;
362 /* Load block group number for goal and relative index */
363 uint32_t bg_id = ext4_balloc_get_bgid_of_block(sb, goal);
364 uint32_t idx_in_bg = ext4_fs_addr_to_idx_bg(sb, goal);
367 struct ext4_block_group_ref bg_ref;
369 /* Load block group reference */
370 r = ext4_fs_get_block_group_ref(inode_ref->fs, bg_id, &bg_ref);
374 struct ext4_bgroup *bg = bg_ref.block_group;
376 free_blocks = ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
377 if (free_blocks == 0) {
378 /* This group has no free blocks */
382 /* Compute indexes */
383 ext4_fsblk_t first_in_bg;
384 first_in_bg = ext4_balloc_get_block_of_bgid(sb, bg_ref.index);
386 uint32_t first_in_bg_index;
387 first_in_bg_index = ext4_fs_addr_to_idx_bg(sb, first_in_bg);
389 if (idx_in_bg < first_in_bg_index)
390 idx_in_bg = first_in_bg_index;
392 /* Load block with bitmap */
393 bmp_blk_adr = ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
395 r = ext4_trans_block_get(inode_ref->fs->bdev, &b, bmp_blk_adr);
397 ext4_fs_put_block_group_ref(&bg_ref);
401 if (!ext4_balloc_verify_bitmap_csum(sb, bg, b.data)) {
402 ext4_dbg(DEBUG_BALLOC,
403 DBG_WARN "Bitmap checksum failed."
404 "Group: %" PRIu32"\n",
408 /* Check if goal is free */
409 if (ext4_bmap_is_bit_clr(b.data, idx_in_bg)) {
410 ext4_bmap_bit_set(b.data, idx_in_bg);
411 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
413 ext4_trans_set_block_dirty(b.buf);
414 r = ext4_block_set(inode_ref->fs->bdev, &b);
416 ext4_fs_put_block_group_ref(&bg_ref);
420 alloc = ext4_fs_bg_idx_to_addr(sb, idx_in_bg, bg_id);
424 uint32_t blk_in_bg = ext4_blocks_in_group_cnt(sb, bg_id);
426 uint32_t end_idx = (idx_in_bg + 63) & ~63;
427 if (end_idx > blk_in_bg)
430 /* Try to find free block near to goal */
432 for (tmp_idx = idx_in_bg + 1; tmp_idx < end_idx; ++tmp_idx) {
433 if (ext4_bmap_is_bit_clr(b.data, tmp_idx)) {
434 ext4_bmap_bit_set(b.data, tmp_idx);
436 ext4_balloc_set_bitmap_csum(sb, bg, b.data);
437 ext4_trans_set_block_dirty(b.buf);
438 r = ext4_block_set(inode_ref->fs->bdev, &b);
442 alloc = ext4_fs_bg_idx_to_addr(sb, tmp_idx, bg_id);
447 /* Find free bit in bitmap */
448 r = ext4_bmap_bit_find_clr(b.data, idx_in_bg, blk_in_bg, &rel_blk_idx);
450 ext4_bmap_bit_set(b.data, rel_blk_idx);
451 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group, b.data);
452 ext4_trans_set_block_dirty(b.buf);
453 r = ext4_block_set(inode_ref->fs->bdev, &b);
457 alloc = ext4_fs_bg_idx_to_addr(sb, rel_blk_idx, bg_id);
461 /* No free block found yet */
462 r = ext4_block_set(inode_ref->fs->bdev, &b);
464 ext4_fs_put_block_group_ref(&bg_ref);
470 r = ext4_fs_put_block_group_ref(&bg_ref);
474 /* Try other block groups */
475 uint32_t block_group_count = ext4_block_group_cnt(sb);
476 uint32_t bgid = (bg_id + 1) % block_group_count;
477 uint32_t count = block_group_count;
480 r = ext4_fs_get_block_group_ref(inode_ref->fs, bgid, &bg_ref);
484 struct ext4_bgroup *bg = bg_ref.block_group;
485 free_blocks = ext4_bg_get_free_blocks_count(bg, sb);
486 if (free_blocks == 0) {
487 /* This group has no free blocks */
491 /* Load block with bitmap */
492 bmp_blk_adr = ext4_bg_get_block_bitmap(bg, sb);
493 r = ext4_trans_block_get(inode_ref->fs->bdev, &b, bmp_blk_adr);
495 ext4_fs_put_block_group_ref(&bg_ref);
499 if (!ext4_balloc_verify_bitmap_csum(sb, bg, b.data)) {
500 ext4_dbg(DEBUG_BALLOC,
501 DBG_WARN "Bitmap checksum failed."
502 "Group: %" PRIu32"\n",
506 /* Compute indexes */
507 first_in_bg = ext4_balloc_get_block_of_bgid(sb, bgid);
508 idx_in_bg = ext4_fs_addr_to_idx_bg(sb, first_in_bg);
509 blk_in_bg = ext4_blocks_in_group_cnt(sb, bgid);
510 first_in_bg_index = ext4_fs_addr_to_idx_bg(sb, first_in_bg);
512 if (idx_in_bg < first_in_bg_index)
513 idx_in_bg = first_in_bg_index;
515 r = ext4_bmap_bit_find_clr(b.data, idx_in_bg, blk_in_bg,
518 ext4_bmap_bit_set(b.data, rel_blk_idx);
519 ext4_balloc_set_bitmap_csum(sb, bg, b.data);
520 ext4_trans_set_block_dirty(b.buf);
521 r = ext4_block_set(inode_ref->fs->bdev, &b);
523 ext4_fs_put_block_group_ref(&bg_ref);
527 alloc = ext4_fs_bg_idx_to_addr(sb, rel_blk_idx, bgid);
531 r = ext4_block_set(inode_ref->fs->bdev, &b);
533 ext4_fs_put_block_group_ref(&bg_ref);
538 r = ext4_fs_put_block_group_ref(&bg_ref);
543 /* Goto next group */
544 bgid = (bgid + 1) % block_group_count;
551 /* Empty command - because of syntax */
554 uint32_t block_size = ext4_sb_get_block_size(sb);
556 /* Update superblock free blocks count */
557 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
559 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
561 /* Update inode blocks (different block size!) count */
562 uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
563 ino_blocks += block_size / EXT4_INODE_BLOCK_SIZE;
564 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
565 inode_ref->dirty = true;
567 /* Update block group free blocks count */
569 uint32_t fb_cnt = ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
571 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, fb_cnt);
574 r = ext4_fs_put_block_group_ref(&bg_ref);
580 int ext4_balloc_try_alloc_block(struct ext4_inode_ref *inode_ref,
581 ext4_fsblk_t baddr, bool *free)
585 struct ext4_fs *fs = inode_ref->fs;
586 struct ext4_sblock *sb = &fs->sb;
588 /* Compute indexes */
589 uint32_t block_group = ext4_balloc_get_bgid_of_block(sb, baddr);
590 uint32_t index_in_group = ext4_fs_addr_to_idx_bg(sb, baddr);
592 /* Load block group reference */
593 struct ext4_block_group_ref bg_ref;
594 rc = ext4_fs_get_block_group_ref(fs, block_group, &bg_ref);
598 /* Load block with bitmap */
599 ext4_fsblk_t bmp_blk_addr;
600 bmp_blk_addr = ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
603 rc = ext4_trans_block_get(fs->bdev, &b, bmp_blk_addr);
605 ext4_fs_put_block_group_ref(&bg_ref);
609 if (!ext4_balloc_verify_bitmap_csum(sb, bg_ref.block_group, b.data)) {
610 ext4_dbg(DEBUG_BALLOC,
611 DBG_WARN "Bitmap checksum failed."
612 "Group: %" PRIu32"\n",
616 /* Check if block is free */
617 *free = ext4_bmap_is_bit_clr(b.data, index_in_group);
619 /* Allocate block if possible */
621 ext4_bmap_bit_set(b.data, index_in_group);
622 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group, b.data);
623 ext4_trans_set_block_dirty(b.buf);
626 /* Release block with bitmap */
627 rc = ext4_block_set(fs->bdev, &b);
629 /* Error in saving bitmap */
630 ext4_fs_put_block_group_ref(&bg_ref);
634 /* If block is not free, return */
638 uint32_t block_size = ext4_sb_get_block_size(sb);
640 /* Update superblock free blocks count */
641 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
643 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
645 /* Update inode blocks count */
646 uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
647 ino_blocks += block_size / EXT4_INODE_BLOCK_SIZE;
648 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
649 inode_ref->dirty = true;
651 /* Update block group free blocks count */
652 uint32_t fb_cnt = ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
654 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, fb_cnt);
659 return ext4_fs_put_block_group_ref(&bg_ref);