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 static uint32_t ext4_balloc_bitmap_csum(struct ext4_sblock *sb,
84 uint32_t checksum = 0;
85 if (ext4_sb_feature_ro_com(sb, EXT4_FRO_COM_METADATA_CSUM)) {
86 uint32_t blocks_per_group =
87 ext4_get32(sb, blocks_per_group);
89 /* First calculate crc32 checksum against fs uuid */
90 checksum = ext4_crc32c(~0, sb->uuid, sizeof(sb->uuid));
91 /* Then calculate crc32 checksum against block_group_desc */
92 checksum = ext4_crc32c(checksum, bitmap,
93 blocks_per_group / 8);
100 * Currently we do not verify the checksum of bitmaps.
103 void ext4_balloc_set_bitmap_csum(struct ext4_sblock *sb,
104 struct ext4_bgroup *bg,
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 int ext4_balloc_free_block(struct ext4_inode_ref *inode_ref, ext4_fsblk_t baddr)
121 struct ext4_fs *fs = inode_ref->fs;
122 struct ext4_sblock *sb = &fs->sb;
124 uint32_t block_group = ext4_balloc_get_bgid_of_block(sb, baddr);
125 uint32_t index_in_group = ext4_fs_baddr2_index_in_group(sb, baddr);
127 /* Load block group reference */
128 struct ext4_block_group_ref bg_ref;
129 int rc = ext4_fs_get_block_group_ref(fs, block_group, &bg_ref);
133 /* Load block with bitmap */
134 ext4_fsblk_t bitmap_block_addr =
135 ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
137 struct ext4_block bitmap_block;
139 rc = ext4_block_get(fs->bdev, &bitmap_block, bitmap_block_addr);
141 ext4_fs_put_block_group_ref(&bg_ref);
146 ext4_bmap_bit_clr(bitmap_block.data, index_in_group);
147 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
149 bitmap_block.dirty = true;
151 /* Release block with bitmap */
152 rc = ext4_block_set(fs->bdev, &bitmap_block);
154 /* Error in saving bitmap */
155 ext4_fs_put_block_group_ref(&bg_ref);
159 uint32_t block_size = ext4_sb_get_block_size(sb);
161 /* Update superblock free blocks count */
162 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
164 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
166 /* Update inode blocks count */
167 uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
168 ino_blocks -= block_size / EXT4_INODE_BLOCK_SIZE;
169 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
170 inode_ref->dirty = true;
172 /* Update block group free blocks count */
173 uint32_t free_blocks =
174 ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
176 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, free_blocks);
180 /* Release block group reference */
181 return ext4_fs_put_block_group_ref(&bg_ref);
184 int ext4_balloc_free_blocks(struct ext4_inode_ref *inode_ref, ext4_fsblk_t first,
188 struct ext4_fs *fs = inode_ref->fs;
189 struct ext4_sblock *sb = &fs->sb;
191 /* Compute indexes */
192 uint32_t block_group_first = ext4_balloc_get_bgid_of_block(sb, first);
194 /* Compute indexes */
195 uint32_t block_group_last =
196 ext4_balloc_get_bgid_of_block(sb, first + count - 1);
198 if (!ext4_sb_feature_incom(sb, EXT4_FINCOM_FLEX_BG)) {
199 /*It is not possible without flex_bg that blocks are continuous
200 * and and last block belongs to other bg.*/
201 ext4_assert(block_group_first == ext4_balloc_get_bgid_of_block(
202 sb, first + count - 1));
205 /* Load block group reference */
206 struct ext4_block_group_ref bg_ref;
207 while (block_group_first <= block_group_last) {
210 ext4_fs_get_block_group_ref(fs, block_group_first, &bg_ref);
214 uint32_t index_in_group_first =
215 ext4_fs_baddr2_index_in_group(sb, first);
217 /* Load block with bitmap */
218 ext4_fsblk_t bitmap_block_addr =
219 ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
221 struct ext4_block bitmap_block;
223 rc = ext4_block_get(fs->bdev, &bitmap_block, bitmap_block_addr);
225 ext4_fs_put_block_group_ref(&bg_ref);
230 ext4_sb_get_block_size(sb) * 8 - index_in_group_first;
232 /*If last block, free only count blocks*/
233 free_cnt = count > free_cnt ? free_cnt : count;
236 ext4_bmap_bits_free(bitmap_block.data, index_in_group_first,
238 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
240 bitmap_block.dirty = true;
245 /* Release block with bitmap */
246 rc = ext4_block_set(fs->bdev, &bitmap_block);
248 ext4_fs_put_block_group_ref(&bg_ref);
252 uint32_t block_size = ext4_sb_get_block_size(sb);
254 /* Update superblock free blocks count */
255 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
256 sb_free_blocks += free_cnt;
257 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
259 /* Update inode blocks count */
260 uint64_t ino_blocks =
261 ext4_inode_get_blocks_count(sb, inode_ref->inode);
262 ino_blocks -= free_cnt * (block_size / EXT4_INODE_BLOCK_SIZE);
263 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
264 inode_ref->dirty = true;
266 /* Update block group free blocks count */
267 uint32_t free_blocks =
268 ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
269 free_blocks += free_cnt;
270 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb,
274 /* Release block group reference */
275 rc = ext4_fs_put_block_group_ref(&bg_ref);
282 /*All blocks should be released*/
283 ext4_assert(count == 0);
287 int ext4_balloc_alloc_block(struct ext4_inode_ref *inode_ref,
289 ext4_fsblk_t *fblock)
291 ext4_fsblk_t allocated_block = 0;
292 ext4_fsblk_t bitmap_block_addr;
293 uint32_t rel_block_idx = 0;
294 uint64_t free_blocks;
295 struct ext4_block bitmap_block;
298 struct ext4_sblock *sb = &inode_ref->fs->sb;
300 /* Load block group number for goal and relative index */
301 uint32_t block_group = ext4_balloc_get_bgid_of_block(sb, goal);
302 uint32_t index_in_group = ext4_fs_baddr2_index_in_group(sb, goal);
304 /* Load block group reference */
305 struct ext4_block_group_ref bg_ref;
306 rc = ext4_fs_get_block_group_ref(inode_ref->fs, block_group, &bg_ref);
310 free_blocks = ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
311 if (free_blocks == 0) {
312 /* This group has no free blocks */
316 /* Compute indexes */
317 ext4_fsblk_t first_in_group = ext4_balloc_get_block_of_bgid(sb, bg_ref.index);
319 uint32_t first_in_group_index =
320 ext4_fs_baddr2_index_in_group(sb, first_in_group);
322 if (index_in_group < first_in_group_index)
323 index_in_group = first_in_group_index;
325 /* Load block with bitmap */
326 bitmap_block_addr = ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
328 rc = ext4_block_get(inode_ref->fs->bdev, &bitmap_block,
331 ext4_fs_put_block_group_ref(&bg_ref);
335 /* Check if goal is free */
336 if (ext4_bmap_is_bit_clr(bitmap_block.data, index_in_group)) {
337 ext4_bmap_bit_set(bitmap_block.data, index_in_group);
338 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
340 bitmap_block.dirty = true;
341 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
343 ext4_fs_put_block_group_ref(&bg_ref);
347 allocated_block = ext4_fs_index_in_group2_baddr(
348 sb, index_in_group, block_group);
353 uint32_t blocks_in_group = ext4_blocks_in_group_cnt(sb, block_group);
355 uint32_t end_idx = (index_in_group + 63) & ~63;
356 if (end_idx > blocks_in_group)
357 end_idx = blocks_in_group;
359 /* Try to find free block near to goal */
361 for (tmp_idx = index_in_group + 1; tmp_idx < end_idx; ++tmp_idx) {
362 if (ext4_bmap_is_bit_clr(bitmap_block.data, tmp_idx)) {
363 ext4_bmap_bit_set(bitmap_block.data, tmp_idx);
365 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
367 bitmap_block.dirty = true;
368 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
372 allocated_block = ext4_fs_index_in_group2_baddr(
373 sb, tmp_idx, block_group);
379 /* Find free bit in bitmap */
380 rc = ext4_bmap_bit_find_clr(bitmap_block.data, index_in_group,
381 blocks_in_group, &rel_block_idx);
383 ext4_bmap_bit_set(bitmap_block.data, rel_block_idx);
384 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
386 bitmap_block.dirty = true;
387 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
391 allocated_block = ext4_fs_index_in_group2_baddr(
392 sb, rel_block_idx, block_group);
397 /* No free block found yet */
398 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
400 ext4_fs_put_block_group_ref(&bg_ref);
406 rc = ext4_fs_put_block_group_ref(&bg_ref);
410 /* Try other block groups */
411 uint32_t block_group_count = ext4_block_group_cnt(sb);
413 uint32_t bgid = (block_group + 1) % block_group_count;
414 uint32_t count = block_group_count;
417 rc = ext4_fs_get_block_group_ref(inode_ref->fs, bgid, &bg_ref);
422 ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
423 if (free_blocks == 0) {
424 /* This group has no free blocks */
428 /* Load block with bitmap */
430 ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
432 rc = ext4_block_get(inode_ref->fs->bdev, &bitmap_block,
436 ext4_fs_put_block_group_ref(&bg_ref);
440 /* Compute indexes */
441 first_in_group = ext4_balloc_get_block_of_bgid(sb, bgid);
443 ext4_fs_baddr2_index_in_group(sb, first_in_group);
444 blocks_in_group = ext4_blocks_in_group_cnt(sb, bgid);
446 first_in_group_index =
447 ext4_fs_baddr2_index_in_group(sb, first_in_group);
449 if (index_in_group < first_in_group_index)
450 index_in_group = first_in_group_index;
452 rc = ext4_bmap_bit_find_clr(bitmap_block.data, index_in_group,
453 blocks_in_group, &rel_block_idx);
457 ext4_bmap_bit_set(bitmap_block.data, rel_block_idx);
459 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
461 bitmap_block.dirty = true;
462 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
464 ext4_fs_put_block_group_ref(&bg_ref);
468 allocated_block = ext4_fs_index_in_group2_baddr(
469 sb, rel_block_idx, bgid);
474 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
476 ext4_fs_put_block_group_ref(&bg_ref);
481 rc = ext4_fs_put_block_group_ref(&bg_ref);
486 /* Goto next group */
487 bgid = (bgid + 1) % block_group_count;
494 /* Empty command - because of syntax */
497 uint32_t block_size = ext4_sb_get_block_size(sb);
499 /* Update superblock free blocks count */
500 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
502 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
504 /* Update inode blocks (different block size!) count */
505 uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
506 ino_blocks += block_size / EXT4_INODE_BLOCK_SIZE;
507 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
508 inode_ref->dirty = true;
510 /* Update block group free blocks count */
511 uint64_t bg_free_blocks =
512 ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
514 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, bg_free_blocks);
518 rc = ext4_fs_put_block_group_ref(&bg_ref);
520 *fblock = allocated_block;
524 int ext4_balloc_try_alloc_block(struct ext4_inode_ref *inode_ref,
525 ext4_fsblk_t baddr, bool *free)
529 struct ext4_fs *fs = inode_ref->fs;
530 struct ext4_sblock *sb = &fs->sb;
532 /* Compute indexes */
533 uint32_t block_group = ext4_balloc_get_bgid_of_block(sb, baddr);
534 uint32_t index_in_group = ext4_fs_baddr2_index_in_group(sb, baddr);
536 /* Load block group reference */
537 struct ext4_block_group_ref bg_ref;
538 rc = ext4_fs_get_block_group_ref(fs, block_group, &bg_ref);
542 /* Load block with bitmap */
543 ext4_fsblk_t bitmap_block_addr =
544 ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
546 struct ext4_block bitmap_block;
548 rc = ext4_block_get(fs->bdev, &bitmap_block, bitmap_block_addr);
550 ext4_fs_put_block_group_ref(&bg_ref);
554 /* Check if block is free */
555 *free = ext4_bmap_is_bit_clr(bitmap_block.data, index_in_group);
557 /* Allocate block if possible */
559 ext4_bmap_bit_set(bitmap_block.data, index_in_group);
560 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
562 bitmap_block.dirty = true;
565 /* Release block with bitmap */
566 rc = ext4_block_set(fs->bdev, &bitmap_block);
568 /* Error in saving bitmap */
569 ext4_fs_put_block_group_ref(&bg_ref);
573 /* If block is not free, return */
577 uint32_t block_size = ext4_sb_get_block_size(sb);
579 /* Update superblock free blocks count */
580 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
582 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
584 /* Update inode blocks count */
585 uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
586 ino_blocks += block_size / EXT4_INODE_BLOCK_SIZE;
587 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
588 inode_ref->dirty = true;
590 /* Update block group free blocks count */
591 uint32_t free_blocks =
592 ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
594 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, free_blocks);
599 return ext4_fs_put_block_group_ref(&bg_ref);