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(EXT4_CRC32_INIT, sb->uuid,
92 /* Then calculate crc32 checksum against block_group_desc */
93 checksum = ext4_crc32c(checksum, bitmap,
94 blocks_per_group / 8);
101 * Currently we do not verify the checksum of bitmaps.
104 void ext4_balloc_set_bitmap_csum(struct ext4_sblock *sb,
105 struct ext4_bgroup *bg,
108 int desc_size = ext4_sb_get_desc_size(sb);
109 uint32_t checksum = ext4_balloc_bitmap_csum(sb, bitmap);
110 uint16_t lo_checksum = to_le16(checksum & 0xFFFF),
111 hi_checksum = to_le16(checksum >> 16);
113 /* See if we need to assign a 32bit checksum */
114 bg->block_bitmap_csum_lo = lo_checksum;
115 if (desc_size == EXT4_MAX_BLOCK_GROUP_DESCRIPTOR_SIZE)
116 bg->block_bitmap_csum_hi = hi_checksum;
120 int ext4_balloc_free_block(struct ext4_inode_ref *inode_ref, ext4_fsblk_t baddr)
122 struct ext4_fs *fs = inode_ref->fs;
123 struct ext4_sblock *sb = &fs->sb;
125 uint32_t block_group = ext4_balloc_get_bgid_of_block(sb, baddr);
126 uint32_t index_in_group = ext4_fs_baddr2_index_in_group(sb, baddr);
128 /* Load block group reference */
129 struct ext4_block_group_ref bg_ref;
130 int rc = ext4_fs_get_block_group_ref(fs, block_group, &bg_ref);
134 /* Load block with bitmap */
135 ext4_fsblk_t bitmap_block_addr =
136 ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
138 struct ext4_block bitmap_block;
140 rc = ext4_block_get(fs->bdev, &bitmap_block, bitmap_block_addr);
142 ext4_fs_put_block_group_ref(&bg_ref);
147 ext4_bmap_bit_clr(bitmap_block.data, index_in_group);
148 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
150 bitmap_block.dirty = true;
152 /* Release block with bitmap */
153 rc = ext4_block_set(fs->bdev, &bitmap_block);
155 /* Error in saving bitmap */
156 ext4_fs_put_block_group_ref(&bg_ref);
160 uint32_t block_size = ext4_sb_get_block_size(sb);
162 /* Update superblock free blocks count */
163 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
165 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
167 /* Update inode blocks count */
168 uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
169 ino_blocks -= block_size / EXT4_INODE_BLOCK_SIZE;
170 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
171 inode_ref->dirty = true;
173 /* Update block group free blocks count */
174 uint32_t free_blocks =
175 ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
177 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, free_blocks);
181 /* Release block group reference */
182 return ext4_fs_put_block_group_ref(&bg_ref);
185 int ext4_balloc_free_blocks(struct ext4_inode_ref *inode_ref, ext4_fsblk_t first,
189 struct ext4_fs *fs = inode_ref->fs;
190 struct ext4_sblock *sb = &fs->sb;
192 /* Compute indexes */
193 uint32_t block_group_first = ext4_balloc_get_bgid_of_block(sb, first);
195 /* Compute indexes */
196 uint32_t block_group_last =
197 ext4_balloc_get_bgid_of_block(sb, first + count - 1);
199 if (!ext4_sb_feature_incom(sb, EXT4_FINCOM_FLEX_BG)) {
200 /*It is not possible without flex_bg that blocks are continuous
201 * and and last block belongs to other bg.*/
202 ext4_assert(block_group_first == ext4_balloc_get_bgid_of_block(
203 sb, first + count - 1));
206 /* Load block group reference */
207 struct ext4_block_group_ref bg_ref;
208 while (block_group_first <= block_group_last) {
211 ext4_fs_get_block_group_ref(fs, block_group_first, &bg_ref);
215 uint32_t index_in_group_first =
216 ext4_fs_baddr2_index_in_group(sb, first);
218 /* Load block with bitmap */
219 ext4_fsblk_t bitmap_block_addr =
220 ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
222 struct ext4_block bitmap_block;
224 rc = ext4_block_get(fs->bdev, &bitmap_block, bitmap_block_addr);
226 ext4_fs_put_block_group_ref(&bg_ref);
231 ext4_sb_get_block_size(sb) * 8 - index_in_group_first;
233 /*If last block, free only count blocks*/
234 free_cnt = count > free_cnt ? free_cnt : count;
237 ext4_bmap_bits_free(bitmap_block.data, index_in_group_first,
239 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
241 bitmap_block.dirty = true;
246 /* Release block with bitmap */
247 rc = ext4_block_set(fs->bdev, &bitmap_block);
249 ext4_fs_put_block_group_ref(&bg_ref);
253 uint32_t block_size = ext4_sb_get_block_size(sb);
255 /* Update superblock free blocks count */
256 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
257 sb_free_blocks += free_cnt;
258 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
260 /* Update inode blocks count */
261 uint64_t ino_blocks =
262 ext4_inode_get_blocks_count(sb, inode_ref->inode);
263 ino_blocks -= free_cnt * (block_size / EXT4_INODE_BLOCK_SIZE);
264 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
265 inode_ref->dirty = true;
267 /* Update block group free blocks count */
268 uint32_t free_blocks =
269 ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
270 free_blocks += free_cnt;
271 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb,
275 /* Release block group reference */
276 rc = ext4_fs_put_block_group_ref(&bg_ref);
283 /*All blocks should be released*/
284 ext4_assert(count == 0);
288 int ext4_balloc_alloc_block(struct ext4_inode_ref *inode_ref,
290 ext4_fsblk_t *fblock)
292 ext4_fsblk_t allocated_block = 0;
293 ext4_fsblk_t bitmap_block_addr;
294 uint32_t rel_block_idx = 0;
295 uint64_t free_blocks;
296 struct ext4_block bitmap_block;
299 struct ext4_sblock *sb = &inode_ref->fs->sb;
301 /* Load block group number for goal and relative index */
302 uint32_t block_group = ext4_balloc_get_bgid_of_block(sb, goal);
303 uint32_t index_in_group = ext4_fs_baddr2_index_in_group(sb, goal);
305 /* Load block group reference */
306 struct ext4_block_group_ref bg_ref;
307 rc = ext4_fs_get_block_group_ref(inode_ref->fs, block_group, &bg_ref);
311 free_blocks = ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
312 if (free_blocks == 0) {
313 /* This group has no free blocks */
317 /* Compute indexes */
318 ext4_fsblk_t first_in_group = ext4_balloc_get_block_of_bgid(sb, bg_ref.index);
320 uint32_t first_in_group_index =
321 ext4_fs_baddr2_index_in_group(sb, first_in_group);
323 if (index_in_group < first_in_group_index)
324 index_in_group = first_in_group_index;
326 /* Load block with bitmap */
327 bitmap_block_addr = ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
329 rc = ext4_block_get(inode_ref->fs->bdev, &bitmap_block,
332 ext4_fs_put_block_group_ref(&bg_ref);
336 /* Check if goal is free */
337 if (ext4_bmap_is_bit_clr(bitmap_block.data, index_in_group)) {
338 ext4_bmap_bit_set(bitmap_block.data, index_in_group);
339 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
341 bitmap_block.dirty = true;
342 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
344 ext4_fs_put_block_group_ref(&bg_ref);
348 allocated_block = ext4_fs_index_in_group2_baddr(
349 sb, index_in_group, block_group);
354 uint32_t blocks_in_group = ext4_blocks_in_group_cnt(sb, block_group);
356 uint32_t end_idx = (index_in_group + 63) & ~63;
357 if (end_idx > blocks_in_group)
358 end_idx = blocks_in_group;
360 /* Try to find free block near to goal */
362 for (tmp_idx = index_in_group + 1; tmp_idx < end_idx; ++tmp_idx) {
363 if (ext4_bmap_is_bit_clr(bitmap_block.data, tmp_idx)) {
364 ext4_bmap_bit_set(bitmap_block.data, tmp_idx);
366 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
368 bitmap_block.dirty = true;
369 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
373 allocated_block = ext4_fs_index_in_group2_baddr(
374 sb, tmp_idx, block_group);
380 /* Find free bit in bitmap */
381 rc = ext4_bmap_bit_find_clr(bitmap_block.data, index_in_group,
382 blocks_in_group, &rel_block_idx);
384 ext4_bmap_bit_set(bitmap_block.data, rel_block_idx);
385 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
387 bitmap_block.dirty = true;
388 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
392 allocated_block = ext4_fs_index_in_group2_baddr(
393 sb, rel_block_idx, block_group);
398 /* No free block found yet */
399 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
401 ext4_fs_put_block_group_ref(&bg_ref);
407 rc = ext4_fs_put_block_group_ref(&bg_ref);
411 /* Try other block groups */
412 uint32_t block_group_count = ext4_block_group_cnt(sb);
414 uint32_t bgid = (block_group + 1) % block_group_count;
415 uint32_t count = block_group_count;
418 rc = ext4_fs_get_block_group_ref(inode_ref->fs, bgid, &bg_ref);
423 ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
424 if (free_blocks == 0) {
425 /* This group has no free blocks */
429 /* Load block with bitmap */
431 ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
433 rc = ext4_block_get(inode_ref->fs->bdev, &bitmap_block,
437 ext4_fs_put_block_group_ref(&bg_ref);
441 /* Compute indexes */
442 first_in_group = ext4_balloc_get_block_of_bgid(sb, bgid);
444 ext4_fs_baddr2_index_in_group(sb, first_in_group);
445 blocks_in_group = ext4_blocks_in_group_cnt(sb, bgid);
447 first_in_group_index =
448 ext4_fs_baddr2_index_in_group(sb, first_in_group);
450 if (index_in_group < first_in_group_index)
451 index_in_group = first_in_group_index;
453 rc = ext4_bmap_bit_find_clr(bitmap_block.data, index_in_group,
454 blocks_in_group, &rel_block_idx);
458 ext4_bmap_bit_set(bitmap_block.data, rel_block_idx);
460 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
462 bitmap_block.dirty = true;
463 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
465 ext4_fs_put_block_group_ref(&bg_ref);
469 allocated_block = ext4_fs_index_in_group2_baddr(
470 sb, rel_block_idx, bgid);
475 rc = ext4_block_set(inode_ref->fs->bdev, &bitmap_block);
477 ext4_fs_put_block_group_ref(&bg_ref);
482 rc = ext4_fs_put_block_group_ref(&bg_ref);
487 /* Goto next group */
488 bgid = (bgid + 1) % block_group_count;
495 /* Empty command - because of syntax */
498 uint32_t block_size = ext4_sb_get_block_size(sb);
500 /* Update superblock free blocks count */
501 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
503 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
505 /* Update inode blocks (different block size!) count */
506 uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
507 ino_blocks += block_size / EXT4_INODE_BLOCK_SIZE;
508 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
509 inode_ref->dirty = true;
511 /* Update block group free blocks count */
512 uint64_t bg_free_blocks =
513 ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
515 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, bg_free_blocks);
519 rc = ext4_fs_put_block_group_ref(&bg_ref);
521 *fblock = allocated_block;
525 int ext4_balloc_try_alloc_block(struct ext4_inode_ref *inode_ref,
526 ext4_fsblk_t baddr, bool *free)
530 struct ext4_fs *fs = inode_ref->fs;
531 struct ext4_sblock *sb = &fs->sb;
533 /* Compute indexes */
534 uint32_t block_group = ext4_balloc_get_bgid_of_block(sb, baddr);
535 uint32_t index_in_group = ext4_fs_baddr2_index_in_group(sb, baddr);
537 /* Load block group reference */
538 struct ext4_block_group_ref bg_ref;
539 rc = ext4_fs_get_block_group_ref(fs, block_group, &bg_ref);
543 /* Load block with bitmap */
544 ext4_fsblk_t bitmap_block_addr =
545 ext4_bg_get_block_bitmap(bg_ref.block_group, sb);
547 struct ext4_block bitmap_block;
549 rc = ext4_block_get(fs->bdev, &bitmap_block, bitmap_block_addr);
551 ext4_fs_put_block_group_ref(&bg_ref);
555 /* Check if block is free */
556 *free = ext4_bmap_is_bit_clr(bitmap_block.data, index_in_group);
558 /* Allocate block if possible */
560 ext4_bmap_bit_set(bitmap_block.data, index_in_group);
561 ext4_balloc_set_bitmap_csum(sb, bg_ref.block_group,
563 bitmap_block.dirty = true;
566 /* Release block with bitmap */
567 rc = ext4_block_set(fs->bdev, &bitmap_block);
569 /* Error in saving bitmap */
570 ext4_fs_put_block_group_ref(&bg_ref);
574 /* If block is not free, return */
578 uint32_t block_size = ext4_sb_get_block_size(sb);
580 /* Update superblock free blocks count */
581 uint64_t sb_free_blocks = ext4_sb_get_free_blocks_cnt(sb);
583 ext4_sb_set_free_blocks_cnt(sb, sb_free_blocks);
585 /* Update inode blocks count */
586 uint64_t ino_blocks = ext4_inode_get_blocks_count(sb, inode_ref->inode);
587 ino_blocks += block_size / EXT4_INODE_BLOCK_SIZE;
588 ext4_inode_set_blocks_count(sb, inode_ref->inode, ino_blocks);
589 inode_ref->dirty = true;
591 /* Update block group free blocks count */
592 uint32_t free_blocks =
593 ext4_bg_get_free_blocks_count(bg_ref.block_group, sb);
595 ext4_bg_set_free_blocks_count(bg_ref.block_group, sb, free_blocks);
600 return ext4_fs_put_block_group_ref(&bg_ref);