4 * Copyright (C) 1993, 1994 Theodore Ts'o. This file may be
5 * redistributed under the terms of the GNU Public License.
19 #ifdef HAVE_SYS_TYPES_H
20 #include <sys/types.h>
22 #ifdef HAVE_SYS_TIME_H
29 #if EXT2_FLAT_INCLUDES
34 #include "ext2fs/ext2_fs.h"
35 #include "ext2fs/ext2fs.h"
36 #include "blkid/blkid.h"
39 #include "support/profile.h"
40 #include "support/prof_err.h"
45 #define _(a) (gettext (a))
47 #define N_(a) gettext_noop (a)
51 #define P_(singular, plural, n) (ngettext (singular, plural, n))
53 #define NLS_CAT_NAME "e2fsprogs"
56 #define LOCALEDIR "/usr/share/locale"
61 #define P_(singular, plural, n) ((n) == 1 ? (singular) : (plural))
65 #define E2FSCK_ATTR(x) __attribute__(x)
67 #define E2FSCK_ATTR(x)
70 #include "support/quotaio.h"
73 * Exit codes used by fsck-type programs
75 #define FSCK_OK 0 /* No errors */
76 #define FSCK_NONDESTRUCT 1 /* File system errors corrected */
77 #define FSCK_REBOOT 2 /* System should be rebooted */
78 #define FSCK_UNCORRECTED 4 /* File system errors left uncorrected */
79 #define FSCK_ERROR 8 /* Operational error */
80 #define FSCK_USAGE 16 /* Usage or syntax error */
81 #define FSCK_CANCELED 32 /* Aborted with a signal or ^C */
82 #define FSCK_LIBRARY 128 /* Shared library error */
85 * The last ext2fs revision level that this version of e2fsck is able to
88 #define E2FSCK_CURRENT_REV 1
91 * The directory information structure; stores directory information
92 * collected in earlier passes, to avoid disk i/o in fetching the
93 * directory information.
96 ext2_ino_t ino; /* Inode number */
97 ext2_ino_t dotdot; /* Parent according to '..' */
98 ext2_ino_t parent; /* Parent according to treewalk */
103 * The indexed directory information structure; stores information for
104 * directories which contain a hash tree index.
107 ext2_ino_t ino; /* Inode number */
108 short depth; /* depth of tree (15 bits) */
110 __u8 casefolded_hash:1;
111 blk_t numblocks; /* number of blocks in dir */
112 struct dx_dirblock_info *dx_block; /* Array of size numblocks */
115 #define DX_DIRBLOCK_ROOT 1
116 #define DX_DIRBLOCK_LEAF 2
117 #define DX_DIRBLOCK_NODE 3
118 #define DX_DIRBLOCK_CORRUPT 4
119 #define DX_DIRBLOCK_CLEARED 8
121 struct dx_dirblock_info {
127 ext2_dirhash_t min_hash;
128 ext2_dirhash_t max_hash;
129 ext2_dirhash_t node_min_hash;
130 ext2_dirhash_t node_max_hash;
133 #define DX_FLAG_REFERENCED 1
134 #define DX_FLAG_DUP_REF 2
135 #define DX_FLAG_FIRST 4
136 #define DX_FLAG_LAST 8
138 #define RESOURCE_TRACK
140 #ifdef RESOURCE_TRACK
142 * This structure is used for keeping track of how much resources have
143 * been used for a particular pass of e2fsck.
145 struct resource_track {
146 struct timeval time_start;
147 struct timeval user_start;
148 struct timeval system_start;
150 unsigned long long bytes_read;
151 unsigned long long bytes_written;
158 #define E2F_OPT_READONLY 0x0001
159 #define E2F_OPT_PREEN 0x0002
160 #define E2F_OPT_YES 0x0004
161 #define E2F_OPT_NO 0x0008
162 #define E2F_OPT_TIME 0x0010
163 #define E2F_OPT_TIME2 0x0020
164 #define E2F_OPT_CHECKBLOCKS 0x0040
165 #define E2F_OPT_DEBUG 0x0080
166 #define E2F_OPT_FORCE 0x0100
167 #define E2F_OPT_WRITECHECK 0x0200
168 #define E2F_OPT_COMPRESS_DIRS 0x0400
169 #define E2F_OPT_FRAGCHECK 0x0800
170 #define E2F_OPT_JOURNAL_ONLY 0x1000 /* only replay the journal */
171 #define E2F_OPT_DISCARD 0x2000
172 #define E2F_OPT_CONVERT_BMAP 0x4000 /* convert blockmap to extent */
173 #define E2F_OPT_FIXES_ONLY 0x8000 /* skip all optimizations */
174 #define E2F_OPT_NOOPT_EXTENTS 0x10000 /* don't optimize extents */
175 #define E2F_OPT_ICOUNT_FULLMAP 0x20000 /* use an array for inode counts */
176 #define E2F_OPT_UNSHARE_BLOCKS 0x40000
181 #define E2F_FLAG_ABORT 0x0001 /* Abort signaled */
182 #define E2F_FLAG_CANCEL 0x0002 /* Cancel signaled */
183 #define E2F_FLAG_SIGNAL_MASK (E2F_FLAG_ABORT | E2F_FLAG_CANCEL)
184 #define E2F_FLAG_RESTART 0x0004 /* Restart signaled */
185 #define E2F_FLAG_RUN_RETURN (E2F_FLAG_SIGNAL_MASK | E2F_FLAG_RESTART)
186 #define E2F_FLAG_RESTART_LATER 0x0008 /* Restart after all iterations done */
187 #define E2F_FLAG_SETJMP_OK 0x0010 /* Setjmp valid for abort */
189 #define E2F_FLAG_PROG_BAR 0x0020 /* Progress bar on screen */
190 #define E2F_FLAG_PROG_SUPPRESS 0x0040 /* Progress suspended */
191 #define E2F_FLAG_JOURNAL_INODE 0x0080 /* Create a new ext3 journal inode */
192 #define E2F_FLAG_SB_SPECIFIED 0x0100 /* The superblock was explicitly
193 * specified by the user */
194 #define E2F_FLAG_RESTARTED 0x0200 /* E2fsck has been restarted */
195 #define E2F_FLAG_RESIZE_INODE 0x0400 /* Request to recreate resize inode */
196 #define E2F_FLAG_GOT_DEVSIZE 0x0800 /* Device size has been fetched */
197 #define E2F_FLAG_EXITING 0x1000 /* E2fsck exiting due to errors */
198 #define E2F_FLAG_TIME_INSANE 0x2000 /* Time is insane */
199 #define E2F_FLAG_PROBLEMS_FIXED 0x4000 /* At least one problem was fixed */
200 #define E2F_FLAG_ALLOC_OK 0x8000 /* Can we allocate blocks? */
202 #define E2F_RESET_FLAGS (E2F_FLAG_TIME_INSANE | E2F_FLAG_PROBLEMS_FIXED)
205 * Defines for indicating the e2fsck pass number
212 #define E2F_PASS_1B 6
215 * Define the extended attribute refcount structure
217 typedef struct ea_refcount *ext2_refcount_t;
220 * This is the global e2fsck structure.
222 typedef struct e2fsck_struct *e2fsck_t;
224 #define MAX_EXTENT_DEPTH_COUNT 5
226 struct e2fsck_struct {
228 const char *program_name;
229 char *filesystem_name;
235 char *problem_log_fn;
236 int flags; /* E2fsck internal flags */
238 unsigned blocksize; /* blocksize */
239 blk64_t use_superblock; /* sb requested by user */
240 blk64_t superblock; /* sb used to open fs */
241 blk64_t num_blocks; /* Total number of blocks */
243 ext2_ino_t free_inodes;
246 blkid_cache blkid; /* blkid cache */
251 unsigned long abort_code;
253 int (*progress)(e2fsck_t ctx, int pass, unsigned long cur,
256 ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */
257 ext2fs_inode_bitmap inode_bad_map; /* Inodes which are bad somehow */
258 ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */
259 ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */
260 ext2fs_inode_bitmap inode_imagic_map; /* AFS inodes */
261 ext2fs_inode_bitmap inode_reg_map; /* Inodes which are regular files*/
263 ext2fs_block_bitmap block_found_map; /* Blocks which are in use */
264 ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */
265 ext2fs_block_bitmap block_ea_map; /* Blocks which are used by EA's */
270 ext2_icount_t inode_count;
271 ext2_icount_t inode_link_info;
273 ext2_refcount_t refcount;
274 ext2_refcount_t refcount_extra;
277 * Quota blocks and inodes to be charged for each ea block.
279 ext2_refcount_t ea_block_quota_blocks;
280 ext2_refcount_t ea_block_quota_inodes;
283 * ea_inode references from attr entries.
285 ext2_refcount_t ea_inode_refs;
288 * Array of flags indicating whether an inode bitmap, block
289 * bitmap, or inode table is invalid
291 int *invalid_inode_bitmap_flag;
292 int *invalid_block_bitmap_flag;
293 int *invalid_inode_table_flag;
294 int invalid_bitmaps; /* There are invalid bitmaps/itable */
302 * For pass1_check_directory and pass1_get_blocks
304 ext2_ino_t stashed_ino;
305 struct ext2_inode *stashed_inode;
308 * Location of the lost and found directory
310 ext2_ino_t lost_and_found;
311 int bad_lost_and_found;
314 * Directory information
316 struct dir_info_db *dir_info;
319 * Indexed directory information
321 ext2_ino_t dx_dir_info_count;
322 ext2_ino_t dx_dir_info_size;
323 struct dx_dir_info *dx_dir_info;
326 * Directories to hash
328 ext2_u32_list dirs_to_hash;
333 int process_inode_size;
334 int inode_buffer_blocks;
335 unsigned int htree_slack_percentage;
338 * ext3 journal support
340 io_channel journal_io;
347 #ifdef RESOURCE_TRACK
349 * For timing purposes
351 struct resource_track global_rtrack;
355 * How we display the progress update (for unix)
359 int progress_last_percent;
360 unsigned int progress_last_time;
361 int interactive; /* Are we connected directly to a tty? */
362 char start_meta[2], stop_meta[2];
365 __u32 fs_directory_count;
366 __u32 fs_regular_count;
367 __u32 fs_blockdev_count;
368 __u32 fs_chardev_count;
369 __u32 fs_links_count;
370 __u32 fs_symlinks_count;
371 __u32 fs_fast_symlinks_count;
373 __u32 fs_total_count;
374 __u32 fs_badblocks_count;
375 __u32 fs_sockets_count;
380 __u32 fs_fragmented_dir;
382 __u32 fs_ext_attr_inodes;
383 __u32 fs_ext_attr_blocks;
384 __u32 extent_depth_count[MAX_EXTENT_DEPTH_COUNT];
388 time_t time_fudge; /* For working around buggy init scripts */
392 ext2_u32_list encrypted_dirs;
394 /* Reserve blocks for root and l+f re-creation */
395 blk64_t root_repair_block, lnf_repair_block;
398 * For the use of callers of the e2fsck functions; not used by
399 * e2fsck functions themselves.
402 ext2fs_block_bitmap block_metadata_map; /* Metadata blocks */
404 /* How much are we allowed to readahead? */
405 unsigned long long readahead_kb;
408 * Inodes to rebuild extent trees
410 ext2fs_inode_bitmap inodes_to_rebuild;
416 /* Data structures to evaluate whether an extent tree needs rebuilding. */
417 struct extent_tree_level {
418 unsigned int num_extents;
419 unsigned int max_extents;
422 struct extent_tree_info {
425 struct extent_tree_level ext_info[MAX_EXTENT_DEPTH_COUNT];
428 /* Used by the region allocation code */
429 typedef __u64 region_addr_t;
430 typedef struct region_struct *region_t;
433 #define strnlen(str, x) e2fsck_strnlen((str),(x))
434 extern int e2fsck_strnlen(const char * s, int count);
438 * Procedure declarations
441 extern void e2fsck_pass1(e2fsck_t ctx);
442 extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf);
443 extern void e2fsck_pass2(e2fsck_t ctx);
444 extern void e2fsck_pass3(e2fsck_t ctx);
445 extern void e2fsck_pass4(e2fsck_t ctx);
446 extern void e2fsck_pass5(e2fsck_t ctx);
449 extern errcode_t e2fsck_allocate_context(e2fsck_t *ret);
450 extern errcode_t e2fsck_reset_context(e2fsck_t ctx);
451 extern void e2fsck_free_context(e2fsck_t ctx);
452 extern int e2fsck_run(e2fsck_t ctx);
456 extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
457 int replace_bad_blocks);
460 extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent);
461 extern void e2fsck_free_dir_info(e2fsck_t ctx);
462 extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
463 extern struct dir_info_iter *e2fsck_dir_info_iter_begin(e2fsck_t ctx);
464 extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx,
465 struct dir_info_iter *);
466 extern void e2fsck_dir_info_iter_end(e2fsck_t ctx, struct dir_info_iter *);
467 extern int e2fsck_dir_info_set_parent(e2fsck_t ctx, ext2_ino_t ino,
469 extern int e2fsck_dir_info_set_dotdot(e2fsck_t ctx, ext2_ino_t ino,
471 extern int e2fsck_dir_info_get_parent(e2fsck_t ctx, ext2_ino_t ino,
473 extern int e2fsck_dir_info_get_dotdot(e2fsck_t ctx, ext2_ino_t ino,
477 extern void e2fsck_add_dx_dir(e2fsck_t ctx, ext2_ino_t ino,
478 struct ext2_inode *inode, int num_blocks);
479 extern struct dx_dir_info *e2fsck_get_dx_dir_info(e2fsck_t ctx, ext2_ino_t ino);
480 extern void e2fsck_free_dx_dir_info(e2fsck_t ctx);
481 extern ext2_ino_t e2fsck_get_num_dx_dirinfo(e2fsck_t ctx);
482 extern struct dx_dir_info *e2fsck_dx_dir_info_iter(e2fsck_t ctx,
483 ext2_ino_t *control);
486 typedef __u64 ea_key_t;
487 typedef __u64 ea_value_t;
489 extern errcode_t ea_refcount_create(size_t size, ext2_refcount_t *ret);
490 extern void ea_refcount_free(ext2_refcount_t refcount);
491 extern errcode_t ea_refcount_fetch(ext2_refcount_t refcount, ea_key_t ea_key,
493 extern errcode_t ea_refcount_increment(ext2_refcount_t refcount,
494 ea_key_t ea_key, ea_value_t *ret);
495 extern errcode_t ea_refcount_decrement(ext2_refcount_t refcount,
496 ea_key_t ea_key, ea_value_t *ret);
497 extern errcode_t ea_refcount_store(ext2_refcount_t refcount, ea_key_t ea_key,
499 extern size_t ext2fs_get_refcount_size(ext2_refcount_t refcount);
500 extern void ea_refcount_intr_begin(ext2_refcount_t refcount);
501 extern ea_key_t ea_refcount_intr_next(ext2_refcount_t refcount,
505 extern const char *ehandler_operation(const char *op);
506 extern void ehandler_init(io_channel channel);
509 struct problem_context;
510 errcode_t e2fsck_rebuild_extents_later(e2fsck_t ctx, ext2_ino_t ino);
511 int e2fsck_ino_will_be_rebuilt(e2fsck_t ctx, ext2_ino_t ino);
512 void e2fsck_pass1e(e2fsck_t ctx);
513 errcode_t e2fsck_check_rebuild_extents(e2fsck_t ctx, ext2_ino_t ino,
514 struct ext2_inode *inode,
515 struct problem_context *pctx);
516 errcode_t e2fsck_should_rebuild_extents(e2fsck_t ctx,
517 struct problem_context *pctx,
518 struct extent_tree_info *eti,
519 struct ext2_extent_info *info);
522 extern errcode_t e2fsck_check_ext3_journal(e2fsck_t ctx);
523 extern errcode_t e2fsck_run_ext3_journal(e2fsck_t ctx);
524 extern void e2fsck_move_ext3_journal(e2fsck_t ctx);
525 extern int e2fsck_fix_ext3_journal_hint(e2fsck_t ctx);
528 extern void set_up_logging(e2fsck_t ctx);
531 extern void e2fsck_hide_quota(e2fsck_t ctx);
532 extern void e2fsck_validate_quota_inodes(e2fsck_t ctx);
535 extern errcode_t e2fsck_setup_icount(e2fsck_t ctx, const char *icount_name,
536 int flags, ext2_icount_t hint,
538 extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int use_shortcuts);
539 extern int e2fsck_pass1_check_device_inode(ext2_filsys fs,
540 struct ext2_inode *inode);
541 extern int e2fsck_pass1_check_symlink(ext2_filsys fs, ext2_ino_t ino,
542 struct ext2_inode *inode, char *buf);
543 extern void e2fsck_clear_inode(e2fsck_t ctx, ext2_ino_t ino,
544 struct ext2_inode *inode, int restart_flag,
546 extern void e2fsck_intercept_block_allocations(e2fsck_t ctx);
549 extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir,
550 ext2_ino_t ino, char *buf);
553 extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode);
554 extern errcode_t e2fsck_expand_directory(e2fsck_t ctx, ext2_ino_t dir,
555 int num, int gauranteed_size);
556 extern ext2_ino_t e2fsck_get_lost_and_found(e2fsck_t ctx, int fix);
557 extern errcode_t e2fsck_adjust_inode_count(e2fsck_t ctx, ext2_ino_t ino,
561 #define E2FSCK_READA_SUPER (0x01)
562 #define E2FSCK_READA_GDT (0x02)
563 #define E2FSCK_READA_BBITMAP (0x04)
564 #define E2FSCK_READA_IBITMAP (0x08)
565 #define E2FSCK_READA_ITABLE (0x10)
566 #define E2FSCK_READA_ALL_FLAGS (0x1F)
567 errcode_t e2fsck_readahead(ext2_filsys fs, int flags, dgrp_t start,
569 #define E2FSCK_RA_DBLIST_IGNORE_BLOCKCNT (0x01)
570 #define E2FSCK_RA_DBLIST_ALL_FLAGS (0x01)
571 errcode_t e2fsck_readahead_dblist(ext2_filsys fs, int flags,
573 unsigned long long start,
574 unsigned long long count);
575 int e2fsck_can_readahead(ext2_filsys fs);
576 unsigned long long e2fsck_guess_readahead(ext2_filsys fs);
579 extern region_t region_create(region_addr_t min, region_addr_t max);
580 extern void region_free(region_t region);
581 extern int region_allocate(region_t region, region_addr_t start, int n);
584 void e2fsck_rehash_dir_later(e2fsck_t ctx, ext2_ino_t ino);
585 int e2fsck_dir_will_be_rehashed(e2fsck_t ctx, ext2_ino_t ino);
586 errcode_t e2fsck_rehash_dir(e2fsck_t ctx, ext2_ino_t ino,
587 struct problem_context *pctx);
588 void e2fsck_rehash_directories(e2fsck_t ctx);
591 void sigcatcher_setup(void);
594 void check_super_block(e2fsck_t ctx);
595 int check_backup_super_block(e2fsck_t ctx);
596 void check_resize_inode(e2fsck_t ctx);
599 extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned long size,
600 const char *description);
601 extern int ask(e2fsck_t ctx, const char * string, int def);
602 extern int ask_yn(e2fsck_t ctx, const char * string, int def);
603 extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
604 extern void log_out(e2fsck_t ctx, const char *fmt, ...)
605 E2FSCK_ATTR((format(printf, 2, 3)));
606 extern void log_err(e2fsck_t ctx, const char *fmt, ...)
607 E2FSCK_ATTR((format(printf, 2, 3)));
608 extern void e2fsck_read_bitmaps(e2fsck_t ctx);
609 extern void e2fsck_write_bitmaps(e2fsck_t ctx);
610 extern void preenhalt(e2fsck_t ctx);
611 extern char *string_copy(e2fsck_t ctx, const char *str, int len);
612 extern int fs_proc_check(const char *fs_name);
613 extern int check_for_modules(const char *fs_name);
614 #ifdef RESOURCE_TRACK
615 extern void print_resource_track(e2fsck_t ctx,
617 struct resource_track *track,
619 extern void init_resource_track(struct resource_track *track,
622 #define print_resource_track(ctx, desc, track, channel) do { } while (0)
623 #define init_resource_track(track, channel) do { } while (0)
625 extern int inode_has_valid_blocks(struct ext2_inode *inode);
626 extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
627 struct ext2_inode * inode, const char * proc);
628 extern void e2fsck_read_inode_full(e2fsck_t ctx, unsigned long ino,
629 struct ext2_inode *inode,
630 const int bufsize, const char *proc);
631 extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
632 struct ext2_inode * inode, const char * proc);
633 extern void e2fsck_write_inode_full(e2fsck_t ctx, unsigned long ino,
634 struct ext2_inode * inode, int bufsize,
637 extern void mtrace_print(char *mesg);
639 extern blk64_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs,
640 const char *name, io_manager manager);
641 extern int ext2_file_type(unsigned int mode);
642 extern int write_all(int fd, char *buf, size_t count);
643 void dump_mmp_msg(struct mmp_struct *mmp, const char *fmt, ...)
644 E2FSCK_ATTR((format(printf, 2, 3)));
645 errcode_t e2fsck_mmp_update(ext2_filsys fs);
647 extern void e2fsck_set_bitmap_type(ext2_filsys fs,
648 unsigned int default_type,
649 const char *profile_name,
650 unsigned int *old_type);
651 extern errcode_t e2fsck_allocate_inode_bitmap(ext2_filsys fs,
654 const char *profile_name,
655 ext2fs_inode_bitmap *ret);
656 extern errcode_t e2fsck_allocate_block_bitmap(ext2_filsys fs,
659 const char *profile_name,
660 ext2fs_block_bitmap *ret);
661 extern errcode_t e2fsck_allocate_subcluster_bitmap(ext2_filsys fs,
664 const char *profile_name,
665 ext2fs_block_bitmap *ret);
666 unsigned long long get_memory_size(void);
669 extern void e2fsck_clear_progbar(e2fsck_t ctx);
670 extern int e2fsck_simple_progress(e2fsck_t ctx, const char *label,
671 float percent, unsigned int dpynum);
673 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
675 #endif /* _E2FSCK_H */