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>
36 blk64_t ext2fs_descriptor_block_loc2(ext2_filsys fs, blk64_t group_block,
43 if (!(fs->super->s_feature_incompat & EXT2_FEATURE_INCOMPAT_META_BG) ||
44 (i < fs->super->s_first_meta_bg))
45 return (group_block + i + 1);
47 bg = EXT2_DESC_PER_BLOCK(fs->super) * i;
48 if (ext2fs_bg_has_super(fs, bg))
50 ret_blk = ext2fs_group_first_block2(fs, bg) + has_super;
52 * If group_block is not the normal value, we're trying to use
53 * the backup group descriptors and superblock --- so use the
54 * alternate location of the second block group in the
55 * metablock group. Ideally we should be testing each bg
56 * descriptor block individually for correctness, but we don't
57 * have the infrastructure in place to do that.
59 if (group_block != fs->super->s_first_data_block &&
60 ((ret_blk + fs->super->s_blocks_per_group) <
61 ext2fs_blocks_count(fs->super)))
62 ret_blk += fs->super->s_blocks_per_group;
66 blk_t ext2fs_descriptor_block_loc(ext2_filsys fs, blk_t group_block, dgrp_t i)
68 return ext2fs_descriptor_block_loc2(fs, group_block, i);
71 errcode_t ext2fs_open(const char *name, int flags, int superblock,
72 unsigned int block_size, io_manager manager,
75 return ext2fs_open2(name, 0, flags, superblock, block_size,
80 * Note: if superblock is non-zero, block-size must also be non-zero.
81 * Superblock and block_size can be zero to use the default size.
83 * Valid flags for ext2fs_open()
85 * EXT2_FLAG_RW - Open the filesystem for read/write.
86 * EXT2_FLAG_FORCE - Open the filesystem even if some of the
87 * features aren't supported.
88 * EXT2_FLAG_JOURNAL_DEV_OK - Open an ext3 journal device
89 * EXT2_FLAG_SKIP_MMP - Open without multi-mount protection check.
90 * EXT2_FLAG_64BITS - Allow 64-bit bitfields (needed for large
93 errcode_t ext2fs_open2(const char *name, const char *io_options,
94 int flags, int superblock,
95 unsigned int block_size, io_manager manager,
100 unsigned long i, first_meta_bg;
102 unsigned int blocks_per_group, io_flags;
103 blk64_t group_block, blk;
105 #ifdef WORDS_BIGENDIAN
106 unsigned int groups_per_block;
107 struct ext2_group_desc *gdp;
111 EXT2_CHECK_MAGIC(manager, EXT2_ET_MAGIC_IO_MANAGER);
113 retval = ext2fs_get_mem(sizeof(struct struct_ext2_filsys), &fs);
117 memset(fs, 0, sizeof(struct struct_ext2_filsys));
118 fs->magic = EXT2_ET_MAGIC_EXT2FS_FILSYS;
120 /* don't overwrite sb backups unless flag is explicitly cleared */
121 fs->flags |= EXT2_FLAG_MASTER_SB_ONLY;
123 retval = ext2fs_get_mem(strlen(name)+1, &fs->device_name);
126 strcpy(fs->device_name, name);
127 cp = strchr(fs->device_name, '?');
128 if (!io_options && cp) {
134 if (flags & EXT2_FLAG_RW)
135 io_flags |= IO_FLAG_RW;
136 if (flags & EXT2_FLAG_EXCLUSIVE)
137 io_flags |= IO_FLAG_EXCLUSIVE;
138 if (flags & EXT2_FLAG_DIRECT_IO)
139 io_flags |= IO_FLAG_DIRECT_IO;
140 retval = manager->open(fs->device_name, io_flags, &fs->io);
144 (retval = io_channel_set_options(fs->io, io_options)))
146 fs->image_io = fs->io;
147 fs->io->app_data = fs;
148 retval = io_channel_alloc_buf(fs->io, -SUPERBLOCK_SIZE, &fs->super);
151 if (flags & EXT2_FLAG_IMAGE_FILE) {
152 retval = ext2fs_get_mem(sizeof(struct ext2_image_hdr),
156 retval = io_channel_read_blk(fs->io, 0,
157 -(int)sizeof(struct ext2_image_hdr),
161 if (fs->image_header->magic_number != EXT2_ET_MAGIC_E2IMAGE)
162 return EXT2_ET_MAGIC_E2IMAGE;
164 block_size = fs->image_header->fs_blocksize;
168 * If the user specifies a specific block # for the
169 * superblock, then he/she must also specify the block size!
170 * Otherwise, read the master superblock located at offset
171 * SUPERBLOCK_OFFSET from the start of the partition.
173 * Note: we only save a backup copy of the superblock if we
174 * are reading the superblock from the primary superblock location.
178 retval = EXT2_ET_INVALID_ARGUMENT;
181 io_channel_set_blksize(fs->io, block_size);
182 group_block = superblock;
185 io_channel_set_blksize(fs->io, SUPERBLOCK_OFFSET);
188 retval = ext2fs_get_mem(SUPERBLOCK_SIZE, &fs->orig_super);
192 retval = io_channel_read_blk(fs->io, superblock, -SUPERBLOCK_SIZE,
197 memcpy(fs->orig_super, fs->super, SUPERBLOCK_SIZE);
199 #ifdef WORDS_BIGENDIAN
200 fs->flags |= EXT2_FLAG_SWAP_BYTES;
201 ext2fs_swap_super(fs->super);
203 if (fs->flags & EXT2_FLAG_SWAP_BYTES) {
204 retval = EXT2_ET_UNIMPLEMENTED;
209 if (fs->super->s_magic != EXT2_SUPER_MAGIC) {
210 retval = EXT2_ET_BAD_MAGIC;
213 if (fs->super->s_rev_level > EXT2_LIB_CURRENT_REV) {
214 retval = EXT2_ET_REV_TOO_HIGH;
219 * Check for feature set incompatibility
221 if (!(flags & EXT2_FLAG_FORCE)) {
222 features = fs->super->s_feature_incompat;
223 #ifdef EXT2_LIB_SOFTSUPP_INCOMPAT
224 if (flags & EXT2_FLAG_SOFTSUPP_FEATURES)
225 features &= ~EXT2_LIB_SOFTSUPP_INCOMPAT;
227 if (features & ~EXT2_LIB_FEATURE_INCOMPAT_SUPP) {
228 retval = EXT2_ET_UNSUPP_FEATURE;
232 features = fs->super->s_feature_ro_compat;
233 #ifdef EXT2_LIB_SOFTSUPP_RO_COMPAT
234 if (flags & EXT2_FLAG_SOFTSUPP_FEATURES)
235 features &= ~EXT2_LIB_SOFTSUPP_RO_COMPAT;
237 if ((flags & EXT2_FLAG_RW) &&
238 (features & ~EXT2_LIB_FEATURE_RO_COMPAT_SUPP)) {
239 retval = EXT2_ET_RO_UNSUPP_FEATURE;
243 if (!(flags & EXT2_FLAG_JOURNAL_DEV_OK) &&
244 (fs->super->s_feature_incompat &
245 EXT3_FEATURE_INCOMPAT_JOURNAL_DEV)) {
246 retval = EXT2_ET_UNSUPP_FEATURE;
251 if ((fs->super->s_log_block_size + EXT2_MIN_BLOCK_LOG_SIZE) >
252 EXT2_MAX_BLOCK_LOG_SIZE) {
253 retval = EXT2_ET_CORRUPT_SUPERBLOCK;
258 * bigalloc requires cluster-aware bitfield operations, which at the
259 * moment means we need EXT2_FLAG_64BITS.
261 if (EXT2_HAS_RO_COMPAT_FEATURE(fs->super,
262 EXT4_FEATURE_RO_COMPAT_BIGALLOC) &&
263 !(flags & EXT2_FLAG_64BITS)) {
264 retval = EXT2_ET_CANT_USE_LEGACY_BITMAPS;
268 if (!EXT2_HAS_RO_COMPAT_FEATURE(fs->super,
269 EXT4_FEATURE_RO_COMPAT_BIGALLOC) &&
270 (fs->super->s_log_block_size != fs->super->s_log_cluster_size)) {
271 retval = EXT2_ET_CORRUPT_SUPERBLOCK;
274 fs->fragsize = fs->blocksize = EXT2_BLOCK_SIZE(fs->super);
275 if (EXT2_INODE_SIZE(fs->super) < EXT2_GOOD_OLD_INODE_SIZE) {
276 retval = EXT2_ET_CORRUPT_SUPERBLOCK;
279 fs->cluster_ratio_bits = fs->super->s_log_cluster_size -
280 fs->super->s_log_block_size;
281 if (EXT2_BLOCKS_PER_GROUP(fs->super) !=
282 EXT2_CLUSTERS_PER_GROUP(fs->super) << fs->cluster_ratio_bits) {
283 retval = EXT2_ET_CORRUPT_SUPERBLOCK;
286 fs->inode_blocks_per_group = ((EXT2_INODES_PER_GROUP(fs->super) *
287 EXT2_INODE_SIZE(fs->super) +
288 EXT2_BLOCK_SIZE(fs->super) - 1) /
289 EXT2_BLOCK_SIZE(fs->super));
291 if (block_size != fs->blocksize) {
292 retval = EXT2_ET_UNEXPECTED_BLOCK_SIZE;
297 * Set the blocksize to the filesystem's blocksize.
299 io_channel_set_blksize(fs->io, fs->blocksize);
302 * If this is an external journal device, don't try to read
303 * the group descriptors, because they're not there.
305 if (fs->super->s_feature_incompat &
306 EXT3_FEATURE_INCOMPAT_JOURNAL_DEV) {
307 fs->group_desc_count = 0;
312 if (EXT2_INODES_PER_GROUP(fs->super) == 0) {
313 retval = EXT2_ET_CORRUPT_SUPERBLOCK;
318 * Read group descriptors
320 blocks_per_group = EXT2_BLOCKS_PER_GROUP(fs->super);
321 if (blocks_per_group == 0 ||
322 blocks_per_group > EXT2_MAX_BLOCKS_PER_GROUP(fs->super) ||
323 fs->inode_blocks_per_group > EXT2_MAX_INODES_PER_GROUP(fs->super) ||
324 EXT2_DESC_PER_BLOCK(fs->super) == 0 ||
325 fs->super->s_first_data_block >= ext2fs_blocks_count(fs->super)) {
326 retval = EXT2_ET_CORRUPT_SUPERBLOCK;
329 fs->group_desc_count = ext2fs_div64_ceil(ext2fs_blocks_count(fs->super) -
330 fs->super->s_first_data_block,
332 if (fs->group_desc_count * EXT2_INODES_PER_GROUP(fs->super) !=
333 fs->super->s_inodes_count) {
334 retval = EXT2_ET_CORRUPT_SUPERBLOCK;
337 fs->desc_blocks = ext2fs_div_ceil(fs->group_desc_count,
338 EXT2_DESC_PER_BLOCK(fs->super));
339 retval = ext2fs_get_array(fs->desc_blocks, fs->blocksize,
344 group_block = fs->super->s_first_data_block;
345 if (group_block == 0 && fs->blocksize == 1024)
346 group_block = 1; /* Deal with 1024 blocksize && bigalloc */
347 dest = (char *) fs->group_desc;
348 #ifdef WORDS_BIGENDIAN
349 groups_per_block = EXT2_DESC_PER_BLOCK(fs->super);
351 if (fs->super->s_feature_incompat & EXT2_FEATURE_INCOMPAT_META_BG)
352 first_meta_bg = fs->super->s_first_meta_bg;
354 first_meta_bg = fs->desc_blocks;
356 retval = io_channel_read_blk(fs->io, group_block+1,
357 first_meta_bg, dest);
360 #ifdef WORDS_BIGENDIAN
361 gdp = (struct ext2_group_desc *) dest;
362 for (j=0; j < groups_per_block*first_meta_bg; j++) {
363 gdp = ext2fs_group_desc(fs, fs->group_desc, j);
364 ext2fs_swap_group_desc2(fs, gdp);
367 dest += fs->blocksize*first_meta_bg;
369 for (i=first_meta_bg ; i < fs->desc_blocks; i++) {
370 blk = ext2fs_descriptor_block_loc2(fs, group_block, i);
371 retval = io_channel_read_blk64(fs->io, blk, 1, dest);
374 #ifdef WORDS_BIGENDIAN
375 for (j=0; j < groups_per_block; j++) {
376 gdp = ext2fs_group_desc(fs, fs->group_desc,
377 i * groups_per_block + j);
378 ext2fs_swap_group_desc2(fs, gdp);
381 dest += fs->blocksize;
384 fs->stride = fs->super->s_raid_stride;
387 * If recovery is from backup superblock, Clear _UNININT flags &
388 * reset bg_itable_unused to zero
390 if (superblock > 1 && EXT2_HAS_RO_COMPAT_FEATURE(fs->super,
391 EXT4_FEATURE_RO_COMPAT_GDT_CSUM)) {
394 for (group = 0; group < fs->group_desc_count; group++) {
395 ext2fs_bg_flags_clear(fs, group, EXT2_BG_BLOCK_UNINIT);
396 ext2fs_bg_flags_clear(fs, group, EXT2_BG_INODE_UNINIT);
397 ext2fs_bg_itable_unused_set(fs, group, 0);
398 /* The checksum will be reset later, but fix it here
399 * anyway to avoid printing a lot of spurious errors. */
400 ext2fs_group_desc_csum_set(fs, group);
402 if (fs->flags & EXT2_FLAG_RW)
403 ext2fs_mark_super_dirty(fs);
406 if ((fs->super->s_feature_incompat & EXT4_FEATURE_INCOMPAT_MMP) &&
407 !(flags & EXT2_FLAG_SKIP_MMP) &&
408 (flags & (EXT2_FLAG_RW | EXT2_FLAG_EXCLUSIVE))) {
409 retval = ext2fs_mmp_start(fs);
411 fs->flags |= EXT2_FLAG_SKIP_MMP; /* just do cleanup */
417 fs->flags &= ~EXT2_FLAG_NOFREE_ON_ERROR;
422 if (flags & EXT2_FLAG_NOFREE_ON_ERROR)
430 * Set/get the filesystem data I/O channel.
432 * These functions are only valid if EXT2_FLAG_IMAGE_FILE is true.
434 errcode_t ext2fs_get_data_io(ext2_filsys fs, io_channel *old_io)
436 if ((fs->flags & EXT2_FLAG_IMAGE_FILE) == 0)
437 return EXT2_ET_NOT_IMAGE_FILE;
439 *old_io = (fs->image_io == fs->io) ? 0 : fs->io;
444 errcode_t ext2fs_set_data_io(ext2_filsys fs, io_channel new_io)
446 if ((fs->flags & EXT2_FLAG_IMAGE_FILE) == 0)
447 return EXT2_ET_NOT_IMAGE_FILE;
448 fs->io = new_io ? new_io : fs->image_io;
452 errcode_t ext2fs_rewrite_to_io(ext2_filsys fs, io_channel new_io)
456 if ((fs->flags & EXT2_FLAG_IMAGE_FILE) == 0)
457 return EXT2_ET_NOT_IMAGE_FILE;
458 err = io_channel_set_blksize(new_io, fs->blocksize);
461 fs->io = fs->image_io = new_io;
462 fs->flags |= EXT2_FLAG_DIRTY | EXT2_FLAG_RW |
463 EXT2_FLAG_BB_DIRTY | EXT2_FLAG_IB_DIRTY;
464 fs->flags &= ~EXT2_FLAG_IMAGE_FILE;