2 * openfs.c --- open an ext2 filesystem
4 * Copyright (C) 1993, 1994, 1995, 1996 Theodore Ts'o.
7 * This file may be redistributed under the terms of the GNU Library
8 * General Public License, version 2.
24 #include <sys/types.h>
35 blk64_t ext2fs_descriptor_block_loc2(ext2_filsys fs, blk64_t group_block,
39 int has_super = 0, group_zero_adjust = 0;
43 * On a bigalloc FS with 1K blocks, block 0 is reserved for non-ext4
44 * stuff, so adjust for that if we're being asked for group 0.
46 if (i == 0 && fs->blocksize == 1024 && EXT2FS_CLUSTER_RATIO(fs) > 1)
47 group_zero_adjust = 1;
49 if (!ext2fs_has_feature_meta_bg(fs->super) ||
50 (i < fs->super->s_first_meta_bg))
51 return group_block + i + 1 + group_zero_adjust;
53 bg = EXT2_DESC_PER_BLOCK(fs->super) * i;
54 if (ext2fs_bg_has_super(fs, bg))
56 ret_blk = ext2fs_group_first_block2(fs, bg);
58 * If group_block is not the normal value, we're trying to use
59 * the backup group descriptors and superblock --- so use the
60 * alternate location of the second block group in the
61 * metablock group. Ideally we should be testing each bg
62 * descriptor block individually for correctness, but we don't
63 * have the infrastructure in place to do that.
65 if (group_block != fs->super->s_first_data_block &&
66 ((ret_blk + has_super + fs->super->s_blocks_per_group) <
67 ext2fs_blocks_count(fs->super))) {
68 ret_blk += fs->super->s_blocks_per_group;
71 * If we're going to jump forward a block group, make sure
72 * that we adjust has_super to account for the next group's
73 * backup superblock (or lack thereof).
75 if (ext2fs_bg_has_super(fs, bg + 1))
80 return ret_blk + has_super + group_zero_adjust;
83 blk_t ext2fs_descriptor_block_loc(ext2_filsys fs, blk_t group_block, dgrp_t i)
85 return ext2fs_descriptor_block_loc2(fs, group_block, i);
88 errcode_t ext2fs_open(const char *name, int flags, int superblock,
89 unsigned int block_size, io_manager manager,
92 return ext2fs_open2(name, 0, flags, superblock, block_size,
96 static void block_sha_map_free_entry(void *data)
103 * Note: if superblock is non-zero, block-size must also be non-zero.
104 * Superblock and block_size can be zero to use the default size.
106 * Valid flags for ext2fs_open()
108 * EXT2_FLAG_RW - Open the filesystem for read/write.
109 * EXT2_FLAG_FORCE - Open the filesystem even if some of the
110 * features aren't supported.
111 * EXT2_FLAG_JOURNAL_DEV_OK - Open an ext3 journal device
112 * EXT2_FLAG_SKIP_MMP - Open without multi-mount protection check.
113 * EXT2_FLAG_64BITS - Allow 64-bit bitfields (needed for large
116 errcode_t ext2fs_open2(const char *name, const char *io_options,
117 int flags, int superblock,
118 unsigned int block_size, io_manager manager,
123 unsigned long i, first_meta_bg;
125 unsigned int blocks_per_group, io_flags;
126 blk64_t group_block, blk;
128 int group_zero_adjust = 0;
129 unsigned int inode_size;
131 #ifdef WORDS_BIGENDIAN
132 unsigned int groups_per_block;
133 struct ext2_group_desc *gdp;
137 int csum_retries = 0;
139 EXT2_CHECK_MAGIC(manager, EXT2_ET_MAGIC_IO_MANAGER);
141 retval = ext2fs_get_mem(sizeof(struct struct_ext2_filsys), &fs);
145 memset(fs, 0, sizeof(struct struct_ext2_filsys));
146 fs->magic = EXT2_ET_MAGIC_EXT2FS_FILSYS;
148 /* don't overwrite sb backups unless flag is explicitly cleared */
149 fs->flags |= EXT2_FLAG_MASTER_SB_ONLY;
152 time_env = getenv("E2FSPROGS_FAKE_TIME");
154 fs->now = strtoul(time_env, NULL, 0);
156 retval = ext2fs_get_mem(strlen(name)+1, &fs->device_name);
159 strcpy(fs->device_name, name);
160 cp = strchr(fs->device_name, '?');
161 if (!io_options && cp) {
167 if (flags & EXT2_FLAG_RW)
168 io_flags |= IO_FLAG_RW;
169 if (flags & EXT2_FLAG_EXCLUSIVE)
170 io_flags |= IO_FLAG_EXCLUSIVE;
171 if (flags & EXT2_FLAG_DIRECT_IO)
172 io_flags |= IO_FLAG_DIRECT_IO;
173 if (flags & EXT2_FLAG_THREADS)
174 io_flags |= IO_FLAG_THREADS;
175 retval = manager->open(fs->device_name, io_flags, &fs->io);
179 (retval = io_channel_set_options(fs->io, io_options)))
181 fs->image_io = fs->io;
182 fs->io->app_data = fs;
183 retval = io_channel_alloc_buf(fs->io, -SUPERBLOCK_SIZE, &fs->super);
186 if (flags & EXT2_FLAG_IMAGE_FILE) {
187 retval = ext2fs_get_mem(sizeof(struct ext2_image_hdr),
191 retval = io_channel_read_blk(fs->io, 0,
192 -(int)sizeof(struct ext2_image_hdr),
196 if (ext2fs_le32_to_cpu(fs->image_header->magic_number) != EXT2_ET_MAGIC_E2IMAGE)
197 return EXT2_ET_MAGIC_E2IMAGE;
199 block_size = ext2fs_le32_to_cpu(fs->image_header->fs_blocksize);
203 * If the user specifies a specific block # for the
204 * superblock, then he/she must also specify the block size!
205 * Otherwise, read the master superblock located at offset
206 * SUPERBLOCK_OFFSET from the start of the partition.
208 * Note: we only save a backup copy of the superblock if we
209 * are reading the superblock from the primary superblock location.
213 retval = EXT2_ET_INVALID_ARGUMENT;
216 io_channel_set_blksize(fs->io, block_size);
217 group_block = superblock;
220 io_channel_set_blksize(fs->io, SUPERBLOCK_OFFSET);
223 retval = ext2fs_get_mem(SUPERBLOCK_SIZE, &fs->orig_super);
228 retval = io_channel_read_blk(fs->io, superblock, -SUPERBLOCK_SIZE,
233 memcpy(fs->orig_super, fs->super, SUPERBLOCK_SIZE);
235 if (!(fs->flags & EXT2_FLAG_IGNORE_CSUM_ERRORS)) {
237 if (!ext2fs_verify_csum_type(fs, fs->super))
238 retval = EXT2_ET_UNKNOWN_CSUM;
239 if (!ext2fs_superblock_csum_verify(fs, fs->super)) {
240 if (csum_retries++ < 3)
242 retval = EXT2_ET_SB_CSUM_INVALID;
246 #ifdef WORDS_BIGENDIAN
247 fs->flags |= EXT2_FLAG_SWAP_BYTES;
248 ext2fs_swap_super(fs->super);
250 if (fs->flags & EXT2_FLAG_SWAP_BYTES) {
251 retval = EXT2_ET_UNIMPLEMENTED;
256 if (fs->super->s_magic != EXT2_SUPER_MAGIC)
257 retval = EXT2_ET_BAD_MAGIC;
261 if (fs->super->s_rev_level > EXT2_LIB_CURRENT_REV) {
262 retval = EXT2_ET_REV_TOO_HIGH;
267 * Check for feature set incompatibility
269 if (!(flags & EXT2_FLAG_FORCE)) {
270 features = fs->super->s_feature_incompat;
271 #ifdef EXT2_LIB_SOFTSUPP_INCOMPAT
272 if (flags & EXT2_FLAG_SOFTSUPP_FEATURES)
273 features &= ~EXT2_LIB_SOFTSUPP_INCOMPAT;
275 if (features & ~EXT2_LIB_FEATURE_INCOMPAT_SUPP) {
276 retval = EXT2_ET_UNSUPP_FEATURE;
280 features = fs->super->s_feature_ro_compat;
281 #ifdef EXT2_LIB_SOFTSUPP_RO_COMPAT
282 if (flags & EXT2_FLAG_SOFTSUPP_FEATURES)
283 features &= ~EXT2_LIB_SOFTSUPP_RO_COMPAT;
285 if ((flags & EXT2_FLAG_RW) &&
286 (features & ~EXT2_LIB_FEATURE_RO_COMPAT_SUPP)) {
287 retval = EXT2_ET_RO_UNSUPP_FEATURE;
291 if (!(flags & EXT2_FLAG_JOURNAL_DEV_OK) &&
292 ext2fs_has_feature_journal_dev(fs->super)) {
293 retval = EXT2_ET_UNSUPP_FEATURE;
298 if ((fs->super->s_log_block_size >
299 (unsigned) (EXT2_MAX_BLOCK_LOG_SIZE - EXT2_MIN_BLOCK_LOG_SIZE)) ||
300 (fs->super->s_log_cluster_size >
301 (unsigned) (EXT2_MAX_CLUSTER_LOG_SIZE - EXT2_MIN_CLUSTER_LOG_SIZE)) ||
302 (fs->super->s_log_block_size > fs->super->s_log_cluster_size) ||
303 (fs->super->s_log_groups_per_flex > 31)) {
304 retval = EXT2_ET_CORRUPT_SUPERBLOCK;
309 * bigalloc requires cluster-aware bitfield operations, which at the
310 * moment means we need EXT2_FLAG_64BITS.
312 if (ext2fs_has_feature_bigalloc(fs->super) &&
313 !(flags & EXT2_FLAG_64BITS)) {
314 retval = EXT2_ET_CANT_USE_LEGACY_BITMAPS;
318 if (!ext2fs_has_feature_bigalloc(fs->super) &&
319 (fs->super->s_log_block_size != fs->super->s_log_cluster_size)) {
320 retval = EXT2_ET_CORRUPT_SUPERBLOCK;
323 fs->fragsize = fs->blocksize = EXT2_BLOCK_SIZE(fs->super);
324 inode_size = EXT2_INODE_SIZE(fs->super);
325 if ((inode_size < EXT2_GOOD_OLD_INODE_SIZE) ||
326 (inode_size > fs->blocksize) ||
327 (inode_size & (inode_size - 1))) {
328 retval = EXT2_ET_CORRUPT_SUPERBLOCK;
332 /* Enforce the block group descriptor size */
333 if (ext2fs_has_feature_64bit(fs->super)) {
334 unsigned desc_size = fs->super->s_desc_size;
336 if (desc_size == 0 ||
337 (!(flags & EXT2_FLAG_IGNORE_SB_ERRORS) &&
338 ((desc_size > EXT2_MAX_DESC_SIZE) ||
339 (desc_size < EXT2_MIN_DESC_SIZE_64BIT) ||
340 (desc_size & (desc_size - 1)) != 0))) {
341 retval = EXT2_ET_BAD_DESC_SIZE;
346 fs->cluster_ratio_bits = fs->super->s_log_cluster_size -
347 fs->super->s_log_block_size;
348 if (EXT2_BLOCKS_PER_GROUP(fs->super) !=
349 EXT2_CLUSTERS_PER_GROUP(fs->super) << fs->cluster_ratio_bits) {
350 retval = EXT2_ET_CORRUPT_SUPERBLOCK;
353 fs->inode_blocks_per_group = ((EXT2_INODES_PER_GROUP(fs->super) *
354 EXT2_INODE_SIZE(fs->super) +
355 EXT2_BLOCK_SIZE(fs->super) - 1) /
356 EXT2_BLOCK_SIZE(fs->super));
358 if (block_size != fs->blocksize) {
359 retval = EXT2_ET_UNEXPECTED_BLOCK_SIZE;
364 * Set the blocksize to the filesystem's blocksize.
366 io_channel_set_blksize(fs->io, fs->blocksize);
369 * If this is an external journal device, don't try to read
370 * the group descriptors, because they're not there.
372 if (ext2fs_has_feature_journal_dev(fs->super)) {
373 fs->group_desc_count = 0;
378 if (EXT2_INODES_PER_GROUP(fs->super) == 0) {
379 retval = EXT2_ET_CORRUPT_SUPERBLOCK;
382 /* Precompute the FS UUID to seed other checksums */
383 ext2fs_init_csum_seed(fs);
386 * Read group descriptors
388 blocks_per_group = EXT2_BLOCKS_PER_GROUP(fs->super);
389 if (blocks_per_group < 8 ||
390 blocks_per_group > EXT2_MAX_BLOCKS_PER_GROUP(fs->super) ||
391 fs->inode_blocks_per_group > EXT2_MAX_INODES_PER_GROUP(fs->super) ||
392 EXT2_DESC_PER_BLOCK(fs->super) == 0 ||
393 fs->super->s_first_data_block >= ext2fs_blocks_count(fs->super)) {
394 retval = EXT2_ET_CORRUPT_SUPERBLOCK;
397 groups_cnt = ext2fs_div64_ceil(ext2fs_blocks_count(fs->super) -
398 fs->super->s_first_data_block,
400 if (groups_cnt >> 32) {
401 retval = EXT2_ET_CORRUPT_SUPERBLOCK;
404 fs->group_desc_count = groups_cnt;
405 if (!(flags & EXT2_FLAG_IGNORE_SB_ERRORS) &&
406 (__u64)fs->group_desc_count * EXT2_INODES_PER_GROUP(fs->super) !=
407 fs->super->s_inodes_count) {
408 retval = EXT2_ET_CORRUPT_SUPERBLOCK;
411 fs->desc_blocks = ext2fs_div_ceil(fs->group_desc_count,
412 EXT2_DESC_PER_BLOCK(fs->super));
413 if (ext2fs_has_feature_meta_bg(fs->super) &&
414 (fs->super->s_first_meta_bg > fs->desc_blocks) &&
415 !(flags & EXT2_FLAG_IGNORE_SB_ERRORS)) {
416 retval = EXT2_ET_CORRUPT_SUPERBLOCK;
419 if (flags & EXT2_FLAG_SUPER_ONLY)
421 retval = ext2fs_get_array(fs->desc_blocks, fs->blocksize,
426 group_block = fs->super->s_first_data_block;
428 * On a FS with a 1K blocksize, block 0 is reserved for bootloaders
429 * so we must increment block numbers to any group 0 items.
431 * However, we cannot touch group_block directly because in the meta_bg
432 * case, the ext2fs_descriptor_block_loc2() function will interpret
433 * group_block != s_first_data_block to mean that we want to access the
434 * backup group descriptors. This is not what we want if the caller
435 * set superblock == 0 (i.e. auto-detect the superblock), which is
436 * what's going on here.
438 if (group_block == 0 && fs->blocksize == 1024)
439 group_zero_adjust = 1;
440 dest = (char *) fs->group_desc;
441 #ifdef WORDS_BIGENDIAN
442 groups_per_block = EXT2_DESC_PER_BLOCK(fs->super);
444 if (ext2fs_has_feature_meta_bg(fs->super) &&
445 !(flags & EXT2_FLAG_IMAGE_FILE)) {
446 first_meta_bg = fs->super->s_first_meta_bg;
447 if (first_meta_bg > fs->desc_blocks)
448 first_meta_bg = fs->desc_blocks;
450 first_meta_bg = fs->desc_blocks;
452 retval = io_channel_read_blk(fs->io, group_block +
453 group_zero_adjust + 1,
454 first_meta_bg, dest);
457 #ifdef WORDS_BIGENDIAN
458 gdp = (struct ext2_group_desc *) dest;
459 for (j=0; j < groups_per_block*first_meta_bg; j++) {
460 gdp = ext2fs_group_desc(fs, fs->group_desc, j);
462 ext2fs_swap_group_desc2(fs, gdp);
465 dest += fs->blocksize*first_meta_bg;
468 for (i = first_meta_bg ; i < fs->desc_blocks; i++) {
469 blk = ext2fs_descriptor_block_loc2(fs, group_block, i);
470 io_channel_cache_readahead(fs->io, blk, 1);
473 for (i=first_meta_bg ; i < fs->desc_blocks; i++) {
474 blk = ext2fs_descriptor_block_loc2(fs, group_block, i);
475 retval = io_channel_read_blk64(fs->io, blk, 1, dest);
478 #ifdef WORDS_BIGENDIAN
479 for (j=0; j < groups_per_block; j++) {
480 gdp = ext2fs_group_desc(fs, fs->group_desc,
481 i * groups_per_block + j);
483 ext2fs_swap_group_desc2(fs, gdp);
486 dest += fs->blocksize;
489 fs->stride = fs->super->s_raid_stride;
492 * If recovery is from backup superblock, Clear _UNININT flags &
493 * reset bg_itable_unused to zero
495 if (superblock > 1 && ext2fs_has_group_desc_csum(fs)) {
498 for (group = 0; group < fs->group_desc_count; group++) {
499 ext2fs_bg_flags_clear(fs, group, EXT2_BG_BLOCK_UNINIT);
500 ext2fs_bg_flags_clear(fs, group, EXT2_BG_INODE_UNINIT);
501 ext2fs_bg_itable_unused_set(fs, group, 0);
502 /* The checksum will be reset later, but fix it here
503 * anyway to avoid printing a lot of spurious errors. */
504 ext2fs_group_desc_csum_set(fs, group);
506 if (fs->flags & EXT2_FLAG_RW)
507 ext2fs_mark_super_dirty(fs);
510 if (ext2fs_has_feature_mmp(fs->super) &&
511 !(flags & EXT2_FLAG_SKIP_MMP) &&
512 (flags & (EXT2_FLAG_RW | EXT2_FLAG_EXCLUSIVE))) {
513 retval = ext2fs_mmp_start(fs);
515 fs->flags |= EXT2_FLAG_SKIP_MMP; /* just do cleanup */
521 if (fs->flags & EXT2_FLAG_SHARE_DUP) {
522 fs->block_sha_map = ext2fs_hashmap_create(ext2fs_djb2_hash,
523 block_sha_map_free_entry, 4096);
524 if (!fs->block_sha_map) {
525 retval = EXT2_ET_NO_MEMORY;
528 ext2fs_set_feature_shared_blocks(fs->super);
531 if (ext2fs_has_feature_casefold(fs->super))
532 fs->encoding = ext2fs_load_nls_table(fs->super->s_encoding);
534 fs->flags &= ~EXT2_FLAG_NOFREE_ON_ERROR;
539 if (!(flags & EXT2_FLAG_NOFREE_ON_ERROR)) {
548 * Set/get the filesystem data I/O channel.
550 * These functions are only valid if EXT2_FLAG_IMAGE_FILE is true.
552 errcode_t ext2fs_get_data_io(ext2_filsys fs, io_channel *old_io)
554 if ((fs->flags & EXT2_FLAG_IMAGE_FILE) == 0)
555 return EXT2_ET_NOT_IMAGE_FILE;
557 *old_io = (fs->image_io == fs->io) ? 0 : fs->io;
562 errcode_t ext2fs_set_data_io(ext2_filsys fs, io_channel new_io)
564 if ((fs->flags & EXT2_FLAG_IMAGE_FILE) == 0)
565 return EXT2_ET_NOT_IMAGE_FILE;
566 fs->io = new_io ? new_io : fs->image_io;
570 errcode_t ext2fs_rewrite_to_io(ext2_filsys fs, io_channel new_io)
574 if ((fs->flags & EXT2_FLAG_IMAGE_FILE) == 0)
575 return EXT2_ET_NOT_IMAGE_FILE;
576 err = io_channel_set_blksize(new_io, fs->blocksize);
579 if ((new_io == fs->image_io) || (new_io == fs->io))
581 if ((fs->image_io != fs->io) &&
583 io_channel_close(fs->image_io);
585 io_channel_close(fs->io);
586 fs->io = fs->image_io = new_io;
587 fs->flags |= EXT2_FLAG_DIRTY | EXT2_FLAG_RW |
588 EXT2_FLAG_BB_DIRTY | EXT2_FLAG_IB_DIRTY;
589 fs->flags &= ~EXT2_FLAG_IMAGE_FILE;