2 * Copyright (c) 2015 Grzegorz Kostka (kostka.grzegorz@gmail.com)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 /** @addtogroup lwext4
37 #include "ext4_config.h"
38 #include "ext4_super.h"
39 #include "ext4_block_group.h"
41 #include "ext4_dir_idx.h"
43 #include "ext4_inode.h"
44 #include "ext4_debug.h"
45 #include "ext4_ialloc.h"
46 #include "ext4_mkfs.h"
52 #define DIV_ROUND_UP(x, y) (((x) + (y) - 1)/(y))
53 #define EXT4_ALIGN(x, y) ((y) * DIV_ROUND_UP((x), (y)))
56 struct ext4_sblock *sb;
57 struct ext4_bgroup *bg_desc;
58 struct xattr_list_element *xattrs;
59 uint32_t first_data_block;
61 uint32_t inode_table_blocks;
63 uint32_t bg_desc_blocks;
64 uint32_t default_i_flags;
65 uint32_t blocks_per_ind;
66 uint32_t blocks_per_dind;
67 uint32_t blocks_per_tind;
70 static inline int log_2(int j)
74 for (i = 0; j > 0; i++)
80 static int sb2info(struct ext4_sblock *sb, struct ext4_mkfs_info *info)
82 if (to_le16(sb->magic) != EXT4_SUPERBLOCK_MAGIC)
85 info->block_size = 1024 << to_le32(sb->log_block_size);
86 info->blocks_per_group = to_le32(sb->blocks_per_group);
87 info->inodes_per_group = to_le32(sb->inodes_per_group);
88 info->inode_size = to_le16(sb->inode_size);
89 info->inodes = to_le32(sb->inodes_count);
90 info->feat_ro_compat = to_le32(sb->features_read_only);
91 info->feat_compat = to_le32(sb->features_compatible);
92 info->feat_incompat = to_le32(sb->features_incompatible);
93 info->bg_desc_reserve_blocks = to_le16(sb->s_reserved_gdt_blocks);
94 info->label = sb->volume_name;
95 info->len = (uint64_t)info->block_size * ext4_sb_get_blocks_cnt(sb);
100 static uint32_t compute_blocks_per_group(struct ext4_mkfs_info *info)
102 return info->block_size * 8;
105 static uint32_t compute_inodes(struct ext4_mkfs_info *info)
107 return DIV_ROUND_UP(info->len, info->block_size) / 4;
110 static uint32_t compute_inodes_per_group(struct ext4_mkfs_info *info)
112 uint32_t blocks = DIV_ROUND_UP(info->len, info->block_size);
113 uint32_t block_groups = DIV_ROUND_UP(blocks, info->blocks_per_group);
114 uint32_t inodes = DIV_ROUND_UP(info->inodes, block_groups);
115 inodes = EXT4_ALIGN(inodes, (info->block_size / info->inode_size));
117 /* After properly rounding up the number of inodes/group,
118 * make sure to update the total inodes field in the info struct.
120 info->inodes = inodes * block_groups;
126 static uint32_t compute_journal_blocks(struct ext4_mkfs_info *info)
128 uint32_t journal_blocks = DIV_ROUND_UP(info->len, info->block_size) / 64;
129 if (journal_blocks < 1024)
130 journal_blocks = 1024;
131 if (journal_blocks > 32768)
132 journal_blocks = 32768;
133 return journal_blocks;
136 static bool has_superblock(struct ext4_mkfs_info *info, uint32_t bgid)
138 if (!(info->feat_ro_compat & EXT4_FRO_COM_SPARSE_SUPER))
141 return ext4_sb_sparse(bgid);
144 static int create_fs_aux_info(struct fs_aux_info *aux_info,
145 struct ext4_mkfs_info *info)
147 aux_info->first_data_block = (info->block_size > 1024) ? 0 : 1;
148 aux_info->len_blocks = info->len / info->block_size;
149 aux_info->inode_table_blocks = DIV_ROUND_UP(info->inodes_per_group *
150 info->inode_size, info->block_size);
151 aux_info->groups = DIV_ROUND_UP(aux_info->len_blocks -
152 aux_info->first_data_block, info->blocks_per_group);
153 aux_info->blocks_per_ind = info->block_size / sizeof(uint32_t);
154 aux_info->blocks_per_dind =
155 aux_info->blocks_per_ind * aux_info->blocks_per_ind;
156 aux_info->blocks_per_tind =
157 aux_info->blocks_per_dind * aux_info->blocks_per_dind;
159 aux_info->bg_desc_blocks =
160 DIV_ROUND_UP(aux_info->groups * sizeof(struct ext4_bgroup),
163 aux_info->default_i_flags = EXT4_INODE_FLAG_NOATIME;
165 uint32_t last_group_size = aux_info->len_blocks % info->blocks_per_group;
166 uint32_t last_header_size = 2 + aux_info->inode_table_blocks;
167 if (has_superblock(info, aux_info->groups - 1))
168 last_header_size += 1 + aux_info->bg_desc_blocks +
169 info->bg_desc_reserve_blocks;
171 if (last_group_size > 0 && last_group_size < last_header_size) {
173 aux_info->len_blocks -= last_group_size;
176 aux_info->sb = calloc(1, EXT4_SUPERBLOCK_SIZE);
180 aux_info->bg_desc = calloc(aux_info->groups, sizeof(struct ext4_bgroup));
181 if (!aux_info->bg_desc)
184 aux_info->xattrs = NULL;
188 static void release_fs_aux_info(struct fs_aux_info *aux_info)
192 if (aux_info->bg_desc)
193 free(aux_info->bg_desc);
197 /* Fill in the superblock memory buffer based on the filesystem parameters */
198 static void fill_in_sb(struct fs_aux_info *aux_info, struct ext4_mkfs_info *info)
200 struct ext4_sblock *sb = aux_info->sb;
202 sb->inodes_count = to_le32(info->inodes_per_group * aux_info->groups);
204 ext4_sb_set_blocks_cnt(sb, aux_info->len_blocks);
205 ext4_sb_set_free_blocks_cnt(sb, aux_info->len_blocks);
206 sb->free_inodes_count = to_le32(info->inodes_per_group * aux_info->groups);
208 sb->reserved_blocks_count_lo = to_le32(0);
209 sb->first_data_block = to_le32(aux_info->first_data_block);
210 sb->log_block_size = to_le32(log_2(info->block_size / 1024));
211 sb->log_cluster_size = to_le32(log_2(info->block_size / 1024));
212 sb->blocks_per_group = to_le32(info->blocks_per_group);
213 sb->frags_per_group = to_le32(info->blocks_per_group);
214 sb->inodes_per_group = to_le32(info->inodes_per_group);
215 sb->mount_time = to_le32(0);
216 sb->write_time = to_le32(0);
217 sb->mount_count = to_le16(0);
218 sb->max_mount_count = to_le16(0xFFFF);
219 sb->magic = to_le16(EXT4_SUPERBLOCK_MAGIC);
220 sb->state = to_le16(EXT4_SUPERBLOCK_STATE_VALID_FS);
221 sb->errors = to_le16(EXT4_SUPERBLOCK_ERRORS_RO);
222 sb->minor_rev_level = to_le16(0);
223 sb->last_check_time = to_le32(0);
224 sb->check_interval = to_le32(0);
225 sb->creator_os = to_le32(EXT4_SUPERBLOCK_OS_LINUX);
226 sb->rev_level = to_le32(1);
227 sb->def_resuid = to_le16(0);
228 sb->def_resgid = to_le16(0);
230 sb->first_inode = to_le32(EXT4_GOOD_OLD_FIRST_INO);
231 sb->inode_size = to_le16(info->inode_size);
232 sb->block_group_index = to_le16(0);
234 sb->features_compatible = to_le32(info->feat_compat);
235 sb->features_incompatible = to_le32(info->feat_incompat);
236 sb->features_read_only = to_le32(info->feat_ro_compat);
238 memset(sb->uuid, 0, sizeof(sb->uuid));
240 memset(sb->volume_name, 0, sizeof(sb->volume_name));
241 strncpy(sb->volume_name, info->label, sizeof(sb->volume_name));
242 memset(sb->last_mounted, 0, sizeof(sb->last_mounted));
244 sb->algorithm_usage_bitmap = to_le32(0);
245 sb->s_prealloc_blocks = 0;
246 sb->s_prealloc_dir_blocks = 0;
247 sb->s_reserved_gdt_blocks = to_le16(info->bg_desc_reserve_blocks);
249 if (info->feat_compat & EXT4_FCOM_HAS_JOURNAL)
250 sb->journal_inode_number = to_le32(EXT4_JOURNAL_INO);
251 sb->journal_dev = to_le32(0);
252 sb->last_orphan = to_le32(0);
253 sb->hash_seed[0] = to_le32(0x11111111);
254 sb->hash_seed[1] = to_le32(0x22222222);
255 sb->hash_seed[2] = to_le32(0x33333333);
256 sb->hash_seed[3] = to_le32(0x44444444);
257 sb->default_hash_version = EXT2_HTREE_HALF_MD4;
258 sb->checksum_type = 1;
259 sb->desc_size = to_le16(info->dsc_size);
260 sb->default_mount_opts = to_le32(0);
261 sb->first_meta_bg = to_le32(0);
262 sb->mkfs_time = to_le32(0);
264 sb->reserved_blocks_count_hi = to_le32(0);
265 sb->min_extra_isize = to_le32(sizeof(struct ext4_inode) -
266 EXT4_GOOD_OLD_INODE_SIZE);
267 sb->want_extra_isize = to_le32(sizeof(struct ext4_inode) -
268 EXT4_GOOD_OLD_INODE_SIZE);
269 sb->flags = to_le32(EXT4_SUPERBLOCK_FLAGS_SIGNED_HASH);
272 static void fill_bgroups(struct fs_aux_info *aux_info,
273 struct ext4_mkfs_info *info)
277 uint64_t bg_free_blk = 0;
278 uint64_t sb_free_blk = 0;
280 for (i = 0; i < aux_info->groups; i++) {
282 uint64_t bg_start_block = aux_info->first_data_block +
283 aux_info->first_data_block + i * info->blocks_per_group;
284 uint32_t blk_off = 0;
286 bg_free_blk = info->blocks_per_group -
287 (aux_info->inode_table_blocks + aux_info->bg_desc_blocks);
290 blk_off += aux_info->bg_desc_blocks;
292 if (has_superblock(info, i)) {
294 blk_off += info->bg_desc_reserve_blocks;
295 bg_free_blk -= info->bg_desc_reserve_blocks + 1;
300 ext4_bg_set_block_bitmap(&aux_info->bg_desc[i], aux_info->sb,
301 bg_start_block + blk_off + 1);
303 ext4_bg_set_inode_bitmap(&aux_info->bg_desc[i], aux_info->sb,
304 bg_start_block + blk_off + 2);
306 ext4_bg_set_inode_table_first_block(&aux_info->bg_desc[i],
308 bg_start_block + blk_off + 3);
310 ext4_bg_set_free_blocks_count(&aux_info->bg_desc[i],
311 aux_info->sb, bg_free_blk);
313 ext4_bg_set_free_inodes_count(&aux_info->bg_desc[i],
314 aux_info->sb, aux_info->sb->inodes_per_group);
316 ext4_bg_set_used_dirs_count(&aux_info->bg_desc[i], aux_info->sb,
319 ext4_bg_set_flag(&aux_info->bg_desc[i],
320 EXT4_BLOCK_GROUP_BLOCK_UNINIT |
321 EXT4_BLOCK_GROUP_INODE_UNINIT);
323 sb_free_blk += bg_free_blk;
326 ext4_sb_set_free_blocks_cnt(aux_info->sb, sb_free_blk);
330 static int write_bgroups(struct ext4_blockdev *bd, struct fs_aux_info *aux_info,
331 struct ext4_mkfs_info *info)
336 for (i = 0; i < aux_info->groups; i++) {
337 uint64_t bg_start_block = aux_info->first_data_block +
338 aux_info->first_data_block + i * info->blocks_per_group;
339 uint32_t blk_off = 0;
341 blk_off += aux_info->bg_desc_blocks;
342 if (has_superblock(info, i)) {
344 blk_off += info->bg_desc_reserve_blocks;
347 uint32_t block_size = ext4_sb_get_block_size(aux_info->sb);
348 uint32_t dsc_pos = 0;
350 uint32_t dsc_size = ext4_sb_get_desc_size(aux_info->sb);
351 uint32_t dsc_blk_cnt = aux_info->bg_desc_blocks;
352 uint64_t dsc_blk = bg_start_block;
354 while (dsc_blk_cnt--) {
355 r = ext4_block_get(bd, &b, dsc_blk++);
359 while (dsc_pos + dsc_size < block_size) {
360 memcpy(b.data + dsc_pos,
361 &aux_info->bg_desc[dsc_id],
369 r = ext4_block_set(bd, &b);
374 r = ext4_block_get_noread(bd, &b, bg_start_block + blk_off + 1);
377 memset(b.data, 0, block_size);
379 r = ext4_block_set(bd, &b);
382 r = ext4_block_get_noread(bd, &b, bg_start_block + blk_off + 2);
385 memset(b.data, 0, block_size);
387 r = ext4_block_set(bd, &b);
396 static int write_sblocks(struct ext4_blockdev *bd, struct fs_aux_info *aux_info,
397 struct ext4_mkfs_info *info)
403 /* write out the backup superblocks */
404 for (i = 1; i < aux_info->groups; i++) {
405 if (has_superblock(info, i)) {
406 offset = info->block_size * (aux_info->first_data_block
407 + i * info->blocks_per_group);
409 aux_info->sb->block_group_index = i;
410 r = ext4_block_writebytes(bd, offset, aux_info->sb,
411 EXT4_SUPERBLOCK_SIZE);
417 /* write out the primary superblock */
418 aux_info->sb->block_group_index = 0;
419 return ext4_block_writebytes(bd, 1024, aux_info->sb,
420 EXT4_SUPERBLOCK_SIZE);
424 int ext4_mkfs_read_info(struct ext4_blockdev *bd, struct ext4_mkfs_info *info)
427 struct ext4_sblock *sb = NULL;
428 r = ext4_block_init(bd);
432 sb = malloc(EXT4_SUPERBLOCK_SIZE);
437 r = ext4_sb_read(bd, sb);
441 r = sb2info(sb, info);
450 static int mkfs_initial(struct ext4_blockdev *bd, struct ext4_mkfs_info *info)
453 struct fs_aux_info aux_info;
454 memset(&aux_info, 0, sizeof(struct fs_aux_info));
456 r = create_fs_aux_info(&aux_info, info);
460 fill_in_sb(&aux_info, info);
461 fill_bgroups(&aux_info, info);
464 r = write_bgroups(bd, &aux_info, info);
468 r = write_sblocks(bd, &aux_info, info);
473 release_fs_aux_info(&aux_info);
477 static int init_bgs(struct ext4_fs *fs)
480 struct ext4_block_group_ref ref;
482 uint32_t bg_count = ext4_block_group_cnt(&fs->sb);
483 for (i = 0; i < bg_count; ++i) {
484 r = ext4_fs_get_block_group_ref(fs, i, &ref);
488 r = ext4_fs_put_block_group_ref(&ref);
495 static int alloc_inodes(struct ext4_fs *fs)
499 struct ext4_inode_ref inode_ref;
500 for (i = 1; i < 12; ++i) {
501 int filetype = EXT4_DIRENTRY_REG_FILE;
505 case EXT4_GOOD_OLD_FIRST_INO:
506 filetype = EXT4_DIRENTRY_DIR;
510 r = ext4_fs_alloc_inode(fs, &inode_ref, filetype);
514 ext4_inode_set_mode(&fs->sb, inode_ref.inode, 0);
515 ext4_fs_put_inode_ref(&inode_ref);
521 static int create_dirs(struct ext4_fs *fs)
524 struct ext4_inode_ref root;
525 struct ext4_inode_ref child;
527 r = ext4_fs_get_inode_ref(fs, EXT4_ROOT_INO, &root);
531 r = ext4_fs_get_inode_ref(fs, EXT4_GOOD_OLD_FIRST_INO, &child);
535 ext4_inode_set_mode(&fs->sb, child.inode,
536 EXT4_INODE_MODE_DIRECTORY | 0777);
538 ext4_inode_set_mode(&fs->sb, root.inode,
539 EXT4_INODE_MODE_DIRECTORY | 0777);
541 #if CONFIG_DIR_INDEX_ENABLE
542 /* Initialize directory index if supported */
543 if (ext4_sb_feature_com(&fs->sb, EXT4_FCOM_DIR_INDEX)) {
544 r = ext4_dir_dx_init(&root, &root);
548 r = ext4_dir_dx_init(&child, &root);
552 ext4_inode_set_flag(root.inode, EXT4_INODE_FLAG_INDEX);
553 ext4_inode_set_flag(child.inode, EXT4_INODE_FLAG_INDEX);
557 r = ext4_dir_add_entry(&root, ".", strlen("."), &root);
561 r = ext4_dir_add_entry(&root, "..", strlen(".."), &root);
565 r = ext4_dir_add_entry(&child, ".", strlen("."), &child);
569 r = ext4_dir_add_entry(&child, "..", strlen(".."), &root);
574 r = ext4_dir_add_entry(&root, "lost+found", strlen("lost+found"), &child);
578 ext4_inode_set_links_count(root.inode, 3);
579 ext4_inode_set_links_count(child.inode, 2);
583 ext4_fs_put_inode_ref(&child);
584 ext4_fs_put_inode_ref(&root);
588 int ext4_mkfs(struct ext4_fs *fs, struct ext4_blockdev *bd,
589 struct ext4_mkfs_info *info)
593 r = ext4_block_init(bd);
598 info->len = bd->ph_bcnt * bd->ph_bsize;
600 if (info->block_size == 0)
601 info->block_size = 4096; /*Set block size to default value*/
603 /* Round down the filesystem length to be a multiple of the block size */
604 info->len &= ~((uint64_t)info->block_size - 1);
606 if (info->journal_blocks == 0)
607 info->journal_blocks = compute_journal_blocks(info);
609 if (info->blocks_per_group == 0)
610 info->blocks_per_group = compute_blocks_per_group(info);
612 if (info->inodes == 0)
613 info->inodes = compute_inodes(info);
615 if (info->inode_size == 0)
616 info->inode_size = 256;
618 if (info->label == NULL)
621 info->inodes_per_group = compute_inodes_per_group(info);
623 info->feat_compat = EXT4_SUPPORTED_FCOM;
624 info->feat_ro_compat = EXT4_SUPPORTED_FRO_COM;
625 info->feat_incompat = EXT4_SUPPORTED_FINCOM;
627 /*TODO: handle this features*/
628 info->feat_incompat &= ~EXT4_FINCOM_META_BG;
629 info->feat_incompat &= ~EXT4_FINCOM_FLEX_BG;
630 info->feat_ro_compat &= ~EXT4_FRO_COM_METADATA_CSUM;
632 if (info->no_journal == 0)
633 info->feat_compat |= 0;
635 if (info->dsc_size == 0) {
637 if (info->feat_incompat & EXT4_FINCOM_64BIT)
638 info->dsc_size = EXT4_MAX_BLOCK_GROUP_DESCRIPTOR_SIZE;
640 info->dsc_size = EXT4_MIN_BLOCK_GROUP_DESCRIPTOR_SIZE;
643 info->bg_desc_reserve_blocks = 0;
645 ext4_dbg(DEBUG_MKFS, DBG_INFO "Creating filesystem with parameters:\n");
646 ext4_dbg(DEBUG_MKFS, DBG_NONE "Size: %"PRIu64"\n", info->len);
647 ext4_dbg(DEBUG_MKFS, DBG_NONE "Block size: %"PRIu32"\n",
649 ext4_dbg(DEBUG_MKFS, DBG_NONE "Blocks per group: %"PRIu32"\n",
650 info->blocks_per_group);
651 ext4_dbg(DEBUG_MKFS, DBG_NONE "Inodes per group: %"PRIu32"\n",
652 info->inodes_per_group);
653 ext4_dbg(DEBUG_MKFS, DBG_NONE "Inode size: %"PRIu32"\n",
655 ext4_dbg(DEBUG_MKFS, DBG_NONE "Inodes: %"PRIu32"\n", info->inodes);
656 ext4_dbg(DEBUG_MKFS, DBG_NONE "Journal blocks: %"PRIu32"\n",
657 info->journal_blocks);
658 ext4_dbg(DEBUG_MKFS, DBG_NONE "Features ro_compat: 0x%x\n",
659 info->feat_ro_compat);
660 ext4_dbg(DEBUG_MKFS, DBG_NONE "Features compat: 0x%x\n",
662 ext4_dbg(DEBUG_MKFS, DBG_NONE "Features incompat: 0x%x\n",
663 info->feat_incompat);
664 ext4_dbg(DEBUG_MKFS, DBG_NONE "BG desc reserve: %"PRIu32"\n",
665 info->bg_desc_reserve_blocks);
666 ext4_dbg(DEBUG_MKFS, DBG_NONE "journal: %s\n",
667 !info->no_journal ? "yes" : "no");
668 ext4_dbg(DEBUG_MKFS, DBG_NONE "Label: %s\n", info->label);
670 struct ext4_bcache bc;
671 memset(&bc, 0, sizeof(struct ext4_bcache));
672 ext4_block_set_lb_size(bd, info->block_size);
673 r = ext4_bcache_init_dynamic(&bc, CONFIG_BLOCK_DEV_CACHE_SIZE,
678 /*Bind block cache to block device*/
679 r = ext4_block_bind_bcache(bd, &bc);
683 r = ext4_block_cache_write_back(bd, 0);
687 r = mkfs_initial(bd, info);
691 r = ext4_fs_init(fs, bd);
699 r = alloc_inodes(fs);
711 ext4_bcache_fini_dynamic(&bc);