2 * initialize.c --- initialize a filesystem handle given superblock
3 * parameters. Used by mke2fs when initializing a filesystem.
5 * Copyright (C) 1994, 1995, 1996 Theodore Ts'o.
8 * This file may be redistributed under the terms of the GNU Library
9 * General Public License, version 2.
25 #include <sys/types.h>
31 #if defined(__linux__) && defined(EXT2_OS_LINUX)
32 #define CREATOR_OS EXT2_OS_LINUX
34 #if defined(__GNU__) && defined(EXT2_OS_HURD)
35 #define CREATOR_OS EXT2_OS_HURD
37 #if defined(__FreeBSD__) && defined(EXT2_OS_FREEBSD)
38 #define CREATOR_OS EXT2_OS_FREEBSD
40 #if defined(LITES) && defined(EXT2_OS_LITES)
41 #define CREATOR_OS EXT2_OS_LITES
43 #define CREATOR_OS EXT2_OS_LINUX /* by default */
44 #endif /* defined(LITES) && defined(EXT2_OS_LITES) */
45 #endif /* defined(__FreeBSD__) && defined(EXT2_OS_FREEBSD) */
46 #endif /* defined(__GNU__) && defined(EXT2_OS_HURD) */
47 #endif /* defined(__linux__) && defined(EXT2_OS_LINUX) */
50 * Calculate the number of GDT blocks to reserve for online filesystem growth.
51 * The absolute maximum number of GDT blocks we can reserve is determined by
52 * the number of block pointers that can fit into a single block.
54 static unsigned int calc_reserved_gdt_blocks(ext2_filsys fs)
56 struct ext2_super_block *sb = fs->super;
57 unsigned long bpg = sb->s_blocks_per_group;
58 unsigned int gdpb = EXT2_DESC_PER_BLOCK(sb);
59 unsigned long max_blocks = 0xffffffff;
60 unsigned long rsv_groups;
63 /* We set it at 1024x the current filesystem size, or
64 * the upper block count limit (2^32), whichever is lower.
66 if (ext2fs_blocks_count(sb) < max_blocks / 1024)
67 max_blocks = ext2fs_blocks_count(sb) * 1024;
69 * ext2fs_div64_ceil() is unnecessary because max_blocks is
70 * max _GDT_ blocks, which is limited to 32 bits.
72 rsv_groups = ext2fs_div_ceil(max_blocks - sb->s_first_data_block, bpg);
73 rsv_gdb = ext2fs_div_ceil(rsv_groups, gdpb) - fs->desc_blocks;
74 if (rsv_gdb > EXT2_ADDR_PER_BLOCK(sb))
75 rsv_gdb = EXT2_ADDR_PER_BLOCK(sb);
77 printf("max_blocks %lu, rsv_groups = %lu, rsv_gdb = %u\n",
78 max_blocks, rsv_groups, rsv_gdb);
84 errcode_t ext2fs_initialize(const char *name, int flags,
85 struct ext2_super_block *param,
86 io_manager manager, ext2_filsys *ret_fs)
90 struct ext2_super_block *super;
92 unsigned int overhead = 0;
101 unsigned reserved_inos;
104 double reserved_ratio;
106 if (!param || !ext2fs_blocks_count(param))
107 return EXT2_ET_INVALID_ARGUMENT;
109 retval = ext2fs_get_mem(sizeof(struct struct_ext2_filsys), &fs);
113 memset(fs, 0, sizeof(struct struct_ext2_filsys));
114 fs->magic = EXT2_ET_MAGIC_EXT2FS_FILSYS;
115 fs->flags = flags | EXT2_FLAG_RW;
117 fs->default_bitmap_type = EXT2FS_BMAP64_RBTREE;
118 #ifdef WORDS_BIGENDIAN
119 fs->flags |= EXT2_FLAG_SWAP_BYTES;
121 io_flags = IO_FLAG_RW;
122 if (flags & EXT2_FLAG_EXCLUSIVE)
123 io_flags |= IO_FLAG_EXCLUSIVE;
124 if (flags & EXT2_FLAG_DIRECT_IO)
125 io_flags |= IO_FLAG_DIRECT_IO;
126 retval = manager->open(name, io_flags, &fs->io);
129 fs->image_io = fs->io;
130 fs->io->app_data = fs;
131 retval = ext2fs_get_mem(strlen(name)+1, &fs->device_name);
135 strcpy(fs->device_name, name);
136 retval = ext2fs_get_mem(SUPERBLOCK_SIZE, &super);
141 memset(super, 0, SUPERBLOCK_SIZE);
143 #define set_field(field, default) (super->field = param->field ? \
144 param->field : (default))
145 #define assign_field(field) (super->field = param->field)
147 super->s_magic = EXT2_SUPER_MAGIC;
148 super->s_state = EXT2_VALID_FS;
150 bigalloc_flag = EXT2_HAS_RO_COMPAT_FEATURE(param,
151 EXT4_FEATURE_RO_COMPAT_BIGALLOC);
153 assign_field(s_log_block_size);
156 set_field(s_log_cluster_size, super->s_log_block_size+4);
157 if (super->s_log_block_size > super->s_log_cluster_size) {
158 retval = EXT2_ET_INVALID_ARGUMENT;
162 super->s_log_cluster_size = super->s_log_block_size;
164 set_field(s_first_data_block, super->s_log_cluster_size ? 0 : 1);
165 set_field(s_max_mnt_count, 0);
166 set_field(s_errors, EXT2_ERRORS_DEFAULT);
167 set_field(s_feature_compat, 0);
168 set_field(s_feature_incompat, 0);
169 set_field(s_feature_ro_compat, 0);
170 set_field(s_default_mount_opts, 0);
171 set_field(s_first_meta_bg, 0);
172 set_field(s_raid_stride, 0); /* default stride size: 0 */
173 set_field(s_raid_stripe_width, 0); /* default stripe width: 0 */
174 set_field(s_log_groups_per_flex, 0);
175 set_field(s_flags, 0);
176 if (super->s_feature_incompat & ~EXT2_LIB_FEATURE_INCOMPAT_SUPP) {
177 retval = EXT2_ET_UNSUPP_FEATURE;
180 if (super->s_feature_ro_compat & ~EXT2_LIB_FEATURE_RO_COMPAT_SUPP) {
181 retval = EXT2_ET_RO_UNSUPP_FEATURE;
185 set_field(s_rev_level, EXT2_GOOD_OLD_REV);
186 if (super->s_rev_level >= EXT2_DYNAMIC_REV) {
187 set_field(s_first_ino, EXT2_GOOD_OLD_FIRST_INO);
188 set_field(s_inode_size, EXT2_GOOD_OLD_INODE_SIZE);
189 if (super->s_inode_size >= sizeof(struct ext2_inode_large)) {
190 int extra_isize = sizeof(struct ext2_inode_large) -
191 EXT2_GOOD_OLD_INODE_SIZE;
192 set_field(s_min_extra_isize, extra_isize);
193 set_field(s_want_extra_isize, extra_isize);
196 super->s_first_ino = EXT2_GOOD_OLD_FIRST_INO;
197 super->s_inode_size = EXT2_GOOD_OLD_INODE_SIZE;
200 set_field(s_checkinterval, 0);
201 super->s_mkfs_time = super->s_lastcheck = fs->now ? fs->now : time(NULL);
203 super->s_creator_os = CREATOR_OS;
205 fs->fragsize = fs->blocksize = EXT2_BLOCK_SIZE(super);
206 fs->cluster_ratio_bits = super->s_log_cluster_size -
207 super->s_log_block_size;
210 unsigned long long bpg;
212 if (param->s_blocks_per_group &&
213 param->s_clusters_per_group &&
214 ((param->s_clusters_per_group * EXT2FS_CLUSTER_RATIO(fs)) !=
215 param->s_blocks_per_group)) {
216 retval = EXT2_ET_INVALID_ARGUMENT;
219 if (param->s_clusters_per_group)
220 assign_field(s_clusters_per_group);
221 else if (param->s_blocks_per_group)
222 super->s_clusters_per_group =
223 param->s_blocks_per_group /
224 EXT2FS_CLUSTER_RATIO(fs);
225 else if (super->s_log_cluster_size + 15 < 32)
226 super->s_clusters_per_group = fs->blocksize * 8;
228 super->s_clusters_per_group = (fs->blocksize - 1) * 8;
229 if (super->s_clusters_per_group > EXT2_MAX_CLUSTERS_PER_GROUP(super))
230 super->s_clusters_per_group = EXT2_MAX_CLUSTERS_PER_GROUP(super);
232 (unsigned long long) super->s_clusters_per_group);
233 if (bpg >= (((unsigned long long) 1) << 32)) {
234 retval = EXT2_ET_INVALID_ARGUMENT;
237 super->s_blocks_per_group = bpg;
239 set_field(s_blocks_per_group, fs->blocksize * 8);
240 if (super->s_blocks_per_group > EXT2_MAX_BLOCKS_PER_GROUP(super))
241 super->s_blocks_per_group = EXT2_MAX_BLOCKS_PER_GROUP(super);
242 super->s_clusters_per_group = super->s_blocks_per_group;
245 ext2fs_blocks_count_set(super, ext2fs_blocks_count(param) &
246 ~((blk64_t) EXT2FS_CLUSTER_MASK(fs)));
247 ext2fs_r_blocks_count_set(super, ext2fs_r_blocks_count(param));
248 if (ext2fs_r_blocks_count(super) >= ext2fs_blocks_count(param)) {
249 retval = EXT2_ET_INVALID_ARGUMENT;
253 set_field(s_mmp_update_interval, 0);
256 * If we're creating an external journal device, we don't need
257 * to bother with the rest.
259 if (super->s_feature_incompat & EXT3_FEATURE_INCOMPAT_JOURNAL_DEV) {
260 fs->group_desc_count = 0;
261 ext2fs_mark_super_dirty(fs);
267 fs->group_desc_count = (dgrp_t) ext2fs_div64_ceil(
268 ext2fs_blocks_count(super) - super->s_first_data_block,
269 EXT2_BLOCKS_PER_GROUP(super));
270 if (fs->group_desc_count == 0) {
271 retval = EXT2_ET_TOOSMALL;
275 if (super->s_feature_incompat & EXT4_FEATURE_INCOMPAT_64BIT)
276 super->s_desc_size = EXT2_MIN_DESC_SIZE_64BIT;
278 fs->desc_blocks = ext2fs_div_ceil(fs->group_desc_count,
279 EXT2_DESC_PER_BLOCK(super));
281 i = fs->blocksize >= 4096 ? 1 : 4096 / fs->blocksize;
283 if (super->s_feature_incompat & EXT4_FEATURE_INCOMPAT_64BIT &&
284 (ext2fs_blocks_count(super) / i) > (1ULL << 32))
285 set_field(s_inodes_count, ~0U);
287 set_field(s_inodes_count, ext2fs_blocks_count(super) / i);
290 * Make sure we have at least EXT2_FIRST_INO + 1 inodes, so
291 * that we have enough inodes for the filesystem(!)
293 if (super->s_inodes_count < EXT2_FIRST_INODE(super)+1)
294 super->s_inodes_count = EXT2_FIRST_INODE(super)+1;
297 * There should be at least as many inodes as the user
298 * requested. Figure out how many inodes per group that
299 * should be. But make sure that we don't allocate more than
300 * one bitmap's worth of inodes each group.
302 ipg = ext2fs_div_ceil(super->s_inodes_count, fs->group_desc_count);
303 if (ipg > fs->blocksize * 8) {
304 if (!bigalloc_flag && super->s_blocks_per_group >= 256) {
305 /* Try again with slightly different parameters */
306 super->s_blocks_per_group -= 8;
307 ext2fs_blocks_count_set(super,
308 ext2fs_blocks_count(param));
309 super->s_clusters_per_group = super->s_blocks_per_group;
312 retval = EXT2_ET_TOO_MANY_INODES;
317 if (ipg > (unsigned) EXT2_MAX_INODES_PER_GROUP(super))
318 ipg = EXT2_MAX_INODES_PER_GROUP(super);
321 super->s_inodes_per_group = ipg;
324 * Make sure the number of inodes per group completely fills
325 * the inode table blocks in the descriptor. If not, add some
326 * additional inodes/group. Waste not, want not...
328 fs->inode_blocks_per_group = (((super->s_inodes_per_group *
329 EXT2_INODE_SIZE(super)) +
330 EXT2_BLOCK_SIZE(super) - 1) /
331 EXT2_BLOCK_SIZE(super));
332 super->s_inodes_per_group = ((fs->inode_blocks_per_group *
333 EXT2_BLOCK_SIZE(super)) /
334 EXT2_INODE_SIZE(super));
336 * Finally, make sure the number of inodes per group is a
337 * multiple of 8. This is needed to simplify the bitmap
340 if (super->s_inodes_per_group < 8)
341 super->s_inodes_per_group = 8;
342 super->s_inodes_per_group &= ~7;
343 fs->inode_blocks_per_group = (((super->s_inodes_per_group *
344 EXT2_INODE_SIZE(super)) +
345 EXT2_BLOCK_SIZE(super) - 1) /
346 EXT2_BLOCK_SIZE(super));
349 * adjust inode count to reflect the adjusted inodes_per_group
351 if ((__u64)super->s_inodes_per_group * fs->group_desc_count > ~0U) {
355 super->s_inodes_count = super->s_inodes_per_group *
356 fs->group_desc_count;
357 super->s_free_inodes_count = super->s_inodes_count;
360 * check the number of reserved group descriptor table blocks
362 if (super->s_feature_compat & EXT2_FEATURE_COMPAT_RESIZE_INODE)
363 rsv_gdt = calc_reserved_gdt_blocks(fs);
366 set_field(s_reserved_gdt_blocks, rsv_gdt);
367 if (super->s_reserved_gdt_blocks > EXT2_ADDR_PER_BLOCK(super)) {
368 retval = EXT2_ET_RES_GDT_BLOCKS;
373 * Calculate the maximum number of bookkeeping blocks per
374 * group. It includes the superblock, the block group
375 * descriptors, the block bitmap, the inode bitmap, the inode
376 * table, and the reserved gdt blocks.
378 overhead = (int) (3 + fs->inode_blocks_per_group +
379 fs->desc_blocks + super->s_reserved_gdt_blocks);
381 /* This can only happen if the user requested too many inodes */
382 if (overhead > super->s_blocks_per_group) {
383 retval = EXT2_ET_TOO_MANY_INODES;
388 * See if the last group is big enough to support the
389 * necessary data structures. If not, we need to get rid of
390 * it. We need to recalculate the overhead for the last block
391 * group, since it might or might not have a superblock
394 overhead = (int) (2 + fs->inode_blocks_per_group);
395 if (ext2fs_bg_has_super(fs, fs->group_desc_count - 1))
396 overhead += 1 + fs->desc_blocks + super->s_reserved_gdt_blocks;
397 rem = ((ext2fs_blocks_count(super) - super->s_first_data_block) %
398 super->s_blocks_per_group);
399 if ((fs->group_desc_count == 1) && rem && (rem < overhead)) {
400 retval = EXT2_ET_TOOSMALL;
403 if (rem && (rem < overhead+50)) {
404 ext2fs_blocks_count_set(super, ext2fs_blocks_count(super) -
407 * If blocks count is changed, we need to recalculate
408 * reserved blocks count not to exceed 50%.
410 reserved_ratio = 100.0 * ext2fs_r_blocks_count(param) /
411 ext2fs_blocks_count(param);
412 ext2fs_r_blocks_count_set(super, reserved_ratio *
413 ext2fs_blocks_count(super) / 100.0);
419 * At this point we know how big the filesystem will be. So
420 * we can do any and all allocations that depend on the block
424 retval = ext2fs_get_mem(strlen(fs->device_name) + 80, &buf);
428 strcpy(buf, "block bitmap for ");
429 strcat(buf, fs->device_name);
430 retval = ext2fs_allocate_subcluster_bitmap(fs, buf, &fs->block_map);
434 strcpy(buf, "inode bitmap for ");
435 strcat(buf, fs->device_name);
436 retval = ext2fs_allocate_inode_bitmap(fs, buf, &fs->inode_map);
440 ext2fs_free_mem(&buf);
442 retval = ext2fs_get_array(fs->desc_blocks, fs->blocksize,
447 memset(fs->group_desc, 0, (size_t) fs->desc_blocks * fs->blocksize);
450 * Reserve the superblock and group descriptors for each
451 * group, and fill in the correct group statistics for group.
452 * Note that although the block bitmap, inode bitmap, and
453 * inode table have not been allocated (and in fact won't be
454 * by this routine), they are accounted for nevertheless.
456 * If FLEX_BG meta-data grouping is used, only account for the
457 * superblock and group descriptors (the inode tables and
458 * bitmaps will be accounted for when allocated).
461 csum_flag = EXT2_HAS_RO_COMPAT_FEATURE(fs->super,
462 EXT4_FEATURE_RO_COMPAT_GDT_CSUM);
463 reserved_inos = super->s_first_ino;
464 for (i = 0; i < fs->group_desc_count; i++) {
466 * Don't set the BLOCK_UNINIT group for the last group
467 * because the block bitmap needs to be padded.
470 if (i != fs->group_desc_count - 1)
471 ext2fs_bg_flags_set(fs, i,
472 EXT2_BG_BLOCK_UNINIT);
473 ext2fs_bg_flags_set(fs, i, EXT2_BG_INODE_UNINIT);
474 numblocks = super->s_inodes_per_group;
476 if (numblocks > reserved_inos) {
477 numblocks -= reserved_inos;
480 reserved_inos -= numblocks;
484 ext2fs_bg_itable_unused_set(fs, i, numblocks);
486 numblocks = ext2fs_reserve_super_and_bgd(fs, i, fs->block_map);
487 if (fs->super->s_log_groups_per_flex)
488 numblocks += 2 + fs->inode_blocks_per_group;
490 free_blocks += numblocks;
491 ext2fs_bg_free_blocks_count_set(fs, i, numblocks);
492 ext2fs_bg_free_inodes_count_set(fs, i, fs->super->s_inodes_per_group);
493 ext2fs_bg_used_dirs_count_set(fs, i, 0);
494 ext2fs_group_desc_csum_set(fs, i);
496 free_blocks &= ~EXT2FS_CLUSTER_MASK(fs);
497 ext2fs_free_blocks_count_set(super, free_blocks);
500 if (((int) c) == -1) {
501 super->s_flags |= EXT2_FLAGS_SIGNED_HASH;
503 super->s_flags |= EXT2_FLAGS_UNSIGNED_HASH;
506 ext2fs_mark_super_dirty(fs);
507 ext2fs_mark_bb_dirty(fs);
508 ext2fs_mark_ib_dirty(fs);
510 io_channel_set_blksize(fs->io, fs->blocksize);