4 * Copyright (C) 1993, 1994 Theodore Ts'o. This file may be
5 * redistributed under the terms of the GNU Public License.
20 #ifdef HAVE_SYS_TYPES_H
21 #include <sys/types.h>
23 #ifdef HAVE_SYS_TIME_H
30 #if EXT2_FLAT_INCLUDES
35 #include "ext2fs/ext2_fs.h"
36 #include "ext2fs/ext2fs.h"
37 #include "blkid/blkid.h"
46 #define _(a) (gettext (a))
48 #define N_(a) gettext_noop (a)
52 #define P_(singular, plural, n) (ngettext (singular, plural, n))
54 #define NLS_CAT_NAME "e2fsprogs"
57 #define LOCALEDIR "/usr/share/locale"
62 #define P_(singular, plural, n) ((n) == 1 ? (singular) : (plural))
66 #define E2FSCK_ATTR(x) __attribute__(x)
68 #define E2FSCK_ATTR(x)
71 #include "quota/quotaio.h"
74 * Exit codes used by fsck-type programs
76 #define FSCK_OK 0 /* No errors */
77 #define FSCK_NONDESTRUCT 1 /* File system errors corrected */
78 #define FSCK_REBOOT 2 /* System should be rebooted */
79 #define FSCK_UNCORRECTED 4 /* File system errors left uncorrected */
80 #define FSCK_ERROR 8 /* Operational error */
81 #define FSCK_USAGE 16 /* Usage or syntax error */
82 #define FSCK_CANCELED 32 /* Aborted with a signal or ^C */
83 #define FSCK_LIBRARY 128 /* Shared library error */
86 * The last ext2fs revision level that this version of e2fsck is able to
89 #define E2FSCK_CURRENT_REV 1
92 * The directory information structure; stores directory information
93 * collected in earlier passes, to avoid disk i/o in fetching the
94 * directory information.
97 ext2_ino_t ino; /* Inode number */
98 ext2_ino_t dotdot; /* Parent according to '..' */
99 ext2_ino_t parent; /* Parent according to treewalk */
104 * The indexed directory information structure; stores information for
105 * directories which contain a hash tree index.
108 ext2_ino_t ino; /* Inode number */
109 int numblocks; /* number of blocks */
111 short depth; /* depth of tree */
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 {
126 ext2_dirhash_t min_hash;
127 ext2_dirhash_t max_hash;
128 ext2_dirhash_t node_min_hash;
129 ext2_dirhash_t node_max_hash;
132 #define DX_FLAG_REFERENCED 1
133 #define DX_FLAG_DUP_REF 2
134 #define DX_FLAG_FIRST 4
135 #define DX_FLAG_LAST 8
137 #define RESOURCE_TRACK
139 #ifdef RESOURCE_TRACK
141 * This structure is used for keeping track of how much resources have
142 * been used for a particular pass of e2fsck.
144 struct resource_track {
145 struct timeval time_start;
146 struct timeval user_start;
147 struct timeval system_start;
149 unsigned long long bytes_read;
150 unsigned long long bytes_written;
157 #define E2F_OPT_READONLY 0x0001
158 #define E2F_OPT_PREEN 0x0002
159 #define E2F_OPT_YES 0x0004
160 #define E2F_OPT_NO 0x0008
161 #define E2F_OPT_TIME 0x0010
162 #define E2F_OPT_TIME2 0x0020
163 #define E2F_OPT_CHECKBLOCKS 0x0040
164 #define E2F_OPT_DEBUG 0x0080
165 #define E2F_OPT_FORCE 0x0100
166 #define E2F_OPT_WRITECHECK 0x0200
167 #define E2F_OPT_COMPRESS_DIRS 0x0400
168 #define E2F_OPT_FRAGCHECK 0x0800
169 #define E2F_OPT_JOURNAL_ONLY 0x1000 /* only replay the journal */
170 #define E2F_OPT_DISCARD 0x2000
175 #define E2F_FLAG_ABORT 0x0001 /* Abort signaled */
176 #define E2F_FLAG_CANCEL 0x0002 /* Cancel signaled */
177 #define E2F_FLAG_SIGNAL_MASK 0x0003
178 #define E2F_FLAG_RESTART 0x0004 /* Restart signaled */
179 #define E2F_FLAG_RESTART_LATER 0x0008 /* Restart after all iterations done */
181 #define E2F_FLAG_SETJMP_OK 0x0010 /* Setjmp valid for abort */
183 #define E2F_FLAG_PROG_BAR 0x0020 /* Progress bar on screen */
184 #define E2F_FLAG_PROG_SUPPRESS 0x0040 /* Progress suspended */
185 #define E2F_FLAG_JOURNAL_INODE 0x0080 /* Create a new ext3 journal inode */
186 #define E2F_FLAG_SB_SPECIFIED 0x0100 /* The superblock was explicitly
187 * specified by the user */
188 #define E2F_FLAG_RESTARTED 0x0200 /* E2fsck has been restarted */
189 #define E2F_FLAG_RESIZE_INODE 0x0400 /* Request to recreate resize inode */
190 #define E2F_FLAG_GOT_DEVSIZE 0x0800 /* Device size has been fetched */
191 #define E2F_FLAG_EXITING 0x1000 /* E2fsck exiting due to errors */
192 #define E2F_FLAG_TIME_INSANE 0x2000 /* Time is insane */
193 #define E2F_FLAG_PROBLEMS_FIXED 0x4000 /* At least one problem was fixed */
194 #define E2F_FLAG_EXPAND_EISIZE 0x8000 /* Expand the inodes (i_extra_isize) */
196 #define E2F_RESET_FLAGS (E2F_FLAG_TIME_INSANE | E2F_FLAG_PROBLEMS_FIXED)
199 * Defines for indicating the e2fsck pass number
206 #define E2F_PASS_1B 6
209 E2F_SHARED_PRESERVE = 0,
219 #define EXT4_FITS_IN_INODE(ext4_inode, einode, field) \
220 ((offsetof(typeof(*ext4_inode), field) + \
221 sizeof(ext4_inode->field)) <= \
222 (EXT2_GOOD_OLD_INODE_SIZE + \
223 (einode)->i_extra_isize)) \
225 #define EXT4_XTIME_FUTURE(ctx, sb, xtime, margin) \
226 (!((ctx)->flags & E2F_FLAG_TIME_INSANE) && \
227 (xtime) > (ctx)->now + (margin))
228 #define EXT4_XTIME_ANCIENT(ctx, sb, xtime, margin) \
229 ((sb)->s_mkfs_time > (margin) && (xtime) < (sb)->s_mkfs_time - (margin))
231 #define BADNESS_NORMAL 1
232 #define BADNESS_HIGH 2
233 #define BADNESS_THRESHOLD 8
234 #define BADNESS_BAD_MODE 100
235 #define BADNESS_LARGE_FILE 2199023255552ULL
238 * Define the extended attribute refcount structure
240 typedef struct ea_refcount *ext2_refcount_t;
243 * This is the global e2fsck structure.
245 typedef struct e2fsck_struct *e2fsck_t;
247 #define MAX_EXTENT_DEPTH_COUNT 5
249 struct e2fsck_struct {
251 const char *program_name;
252 char *filesystem_name;
257 int flags; /* E2fsck internal flags */
259 int blocksize; /* blocksize */
260 blk64_t use_superblock; /* sb requested by user */
261 blk64_t superblock; /* sb used to open fs */
262 blk64_t num_blocks; /* Total number of blocks */
267 blkid_cache blkid; /* blkid cache */
272 unsigned long abort_code;
274 int (*progress)(e2fsck_t ctx, int pass, unsigned long cur,
277 ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */
278 ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */
279 ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */
280 ext2fs_inode_bitmap inode_imagic_map; /* AFS inodes */
281 ext2fs_inode_bitmap inode_reg_map; /* Inodes which are regular files*/
282 ext2fs_inode_bitmap inode_ea_map; /* EA inodes which are non-orphan */
284 ext2fs_block_bitmap block_found_map; /* Blocks which are in use */
285 ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */
286 ext2fs_block_bitmap block_ea_map; /* Blocks which are used by EA's */
291 ext2_icount_t inode_count;
292 ext2_icount_t inode_link_info;
293 ext2_icount_t inode_badness;
294 int inode_badness_threshold;
296 ext2_refcount_t refcount;
297 ext2_refcount_t refcount_extra;
300 * Array of flags indicating whether an inode bitmap, block
301 * bitmap, or inode table is invalid
303 int *invalid_inode_bitmap_flag;
304 int *invalid_block_bitmap_flag;
305 int *invalid_inode_table_flag;
306 int invalid_bitmaps; /* There are invalid bitmaps/itable */
314 * For pass1_check_directory and pass1_get_blocks
316 ext2_ino_t stashed_ino;
317 struct ext2_inode *stashed_inode;
320 * Location of the lost and found directory
322 ext2_ino_t lost_and_found;
323 int bad_lost_and_found;
326 * Directory information
328 struct dir_info_db *dir_info;
331 * Indexed directory information
333 int dx_dir_info_count;
334 int dx_dir_info_size;
335 struct dx_dir_info *dx_dir_info;
338 * Directories to hash
340 ext2_u32_list dirs_to_hash;
345 int process_inode_size;
346 int inode_buffer_blocks;
347 unsigned int htree_slack_percentage;
350 * ext3 journal support
352 io_channel journal_io;
359 #ifdef RESOURCE_TRACK
361 * For timing purposes
363 struct resource_track global_rtrack;
367 * How we display the progress update (for unix)
371 int progress_last_percent;
372 unsigned int progress_last_time;
373 int interactive; /* Are we connected directly to a tty? */
374 char start_meta[2], stop_meta[2];
377 __u32 fs_directory_count;
378 __u32 fs_regular_count;
379 __u32 fs_blockdev_count;
380 __u32 fs_chardev_count;
381 __u32 fs_links_count;
382 __u32 fs_symlinks_count;
383 __u32 fs_fast_symlinks_count;
385 __u32 fs_total_count;
386 __u32 fs_badblocks_count;
387 __u32 fs_sockets_count;
392 __u32 fs_fragmented_dir;
394 __u32 fs_ext_attr_inodes;
395 __u32 fs_ext_attr_blocks;
396 __u32 extent_depth_count[MAX_EXTENT_DEPTH_COUNT];
400 time_t time_fudge; /* For working around buggy init scripts */
402 enum shared_opt shared;
403 enum clone_opt clone;
407 /* Expand large inodes to atleast these many bytes */
408 int want_extra_isize;
409 /* minimum i_extra_isize found in used inodes. Should not be lesser
410 * than s_min_extra_isize.
412 __u32 min_extra_isize;
413 int fs_unexpanded_inodes;
414 ext2fs_inode_bitmap expand_eisize_map;
416 /* Reserve blocks for root and l+f re-creation */
417 blk64_t root_repair_block, lnf_repair_block;
420 * For the use of callers of the e2fsck functions; not used by
421 * e2fsck functions themselves.
426 /* Used by the region allocation code */
427 typedef __u32 region_addr_t;
428 typedef struct region_struct *region_t;
431 #define strnlen(str, x) e2fsck_strnlen((str),(x))
432 extern int e2fsck_strnlen(const char * s, int count);
436 * Procedure declarations
439 extern void e2fsck_pass1(e2fsck_t ctx);
440 extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf);
441 extern void e2fsck_pass2(e2fsck_t ctx);
442 extern void e2fsck_pass3(e2fsck_t ctx);
443 extern void e2fsck_pass4(e2fsck_t ctx);
444 extern void e2fsck_pass5(e2fsck_t ctx);
447 extern errcode_t e2fsck_allocate_context(e2fsck_t *ret);
448 extern errcode_t e2fsck_reset_context(e2fsck_t ctx);
449 extern void e2fsck_free_context(e2fsck_t ctx);
450 extern int e2fsck_run(e2fsck_t ctx);
454 extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
455 int replace_bad_blocks);
458 extern __u32 crc32_be(__u32 crc, unsigned char const *p, size_t len);
461 extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent);
462 extern void e2fsck_free_dir_info(e2fsck_t ctx);
463 extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
464 extern struct dir_info_iter *e2fsck_dir_info_iter_begin(e2fsck_t ctx);
465 extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx,
466 struct dir_info_iter *);
467 extern void e2fsck_dir_info_iter_end(e2fsck_t ctx, struct dir_info_iter *);
468 extern int e2fsck_dir_info_set_parent(e2fsck_t ctx, ext2_ino_t ino,
470 extern int e2fsck_dir_info_set_dotdot(e2fsck_t ctx, ext2_ino_t ino,
472 extern int e2fsck_dir_info_get_parent(e2fsck_t ctx, ext2_ino_t ino,
474 extern int e2fsck_dir_info_get_dotdot(e2fsck_t ctx, ext2_ino_t ino,
478 extern void e2fsck_add_dx_dir(e2fsck_t ctx, ext2_ino_t ino, 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 int e2fsck_get_num_dx_dirinfo(e2fsck_t ctx);
482 extern struct dx_dir_info *e2fsck_dx_dir_info_iter(e2fsck_t ctx, int *control);
485 extern errcode_t ea_refcount_create(int size, ext2_refcount_t *ret);
486 extern void ea_refcount_free(ext2_refcount_t refcount);
487 extern errcode_t ea_refcount_fetch(ext2_refcount_t refcount, blk64_t blk, int *ret);
488 extern errcode_t ea_refcount_increment(ext2_refcount_t refcount,
489 blk64_t blk, int *ret);
490 extern errcode_t ea_refcount_decrement(ext2_refcount_t refcount,
491 blk64_t blk, int *ret);
492 extern errcode_t ea_refcount_store(ext2_refcount_t refcount,
493 blk64_t blk, int count);
494 extern blk_t ext2fs_get_refcount_size(ext2_refcount_t refcount);
495 extern void ea_refcount_intr_begin(ext2_refcount_t refcount);
496 extern blk64_t ea_refcount_intr_next(ext2_refcount_t refcount, int *ret);
499 extern const char *ehandler_operation(const char *op);
500 extern void ehandler_init(io_channel channel);
503 extern errcode_t e2fsck_check_ext3_journal(e2fsck_t ctx);
504 extern errcode_t e2fsck_run_ext3_journal(e2fsck_t ctx);
505 extern void e2fsck_move_ext3_journal(e2fsck_t ctx);
506 extern int e2fsck_fix_ext3_journal_hint(e2fsck_t ctx);
509 extern void set_up_logging(e2fsck_t ctx);
512 extern void e2fsck_hide_quota(e2fsck_t ctx);
515 extern void e2fsck_setup_tdb_icount(e2fsck_t ctx, int flags,
517 extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int use_shortcuts);
518 extern int e2fsck_pass1_check_device_inode(ext2_filsys fs,
519 struct ext2_inode *inode);
520 extern int e2fsck_pass1_check_symlink(e2fsck_t ctx, ext2_ino_t ino,
521 struct ext2_inode *inode, char *buf);
522 extern void e2fsck_clear_inode(e2fsck_t ctx, ext2_ino_t ino,
523 struct ext2_inode *inode, int restart_flag,
525 #define e2fsck_mark_inode_bad(ctx, ino, count) \
526 e2fsck_mark_inode_bad_loc(ctx, ino, count, __func__, __LINE__)
527 extern void e2fsck_mark_inode_bad_loc(e2fsck_t ctx, ino_t ino, int count,
528 const char *func, const int line);
529 extern int is_inode_bad(e2fsck_t ctx, ino_t ino);
530 extern void e2fsck_intercept_block_allocations(e2fsck_t ctx);
533 extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir,
534 ext2_ino_t ino, char *buf);
537 extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode);
538 extern errcode_t e2fsck_expand_directory(e2fsck_t ctx, ext2_ino_t dir,
539 int num, int gauranteed_size);
540 extern ext2_ino_t e2fsck_get_lost_and_found(e2fsck_t ctx, int fix);
541 extern errcode_t e2fsck_adjust_inode_count(e2fsck_t ctx, ext2_ino_t ino,
546 extern region_t region_create(region_addr_t min, region_addr_t max);
547 extern void region_free(region_t region);
548 extern int region_allocate(region_t region, region_addr_t start, int n);
551 errcode_t e2fsck_rehash_dir(e2fsck_t ctx, ext2_ino_t ino);
552 void e2fsck_rehash_directories(e2fsck_t ctx);
555 void sigcatcher_setup(void);
558 void check_super_block(e2fsck_t ctx);
559 int check_backup_super_block(e2fsck_t ctx);
560 void check_resize_inode(e2fsck_t ctx);
563 extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
564 const char *description);
565 extern int ask(e2fsck_t ctx, const char * string, int def);
566 extern int ask_yn(e2fsck_t ctx, const char * string, int def);
567 extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
568 extern void log_out(e2fsck_t ctx, const char *fmt, ...)
569 E2FSCK_ATTR((format(printf, 2, 3)));
570 extern void log_err(e2fsck_t ctx, const char *fmt, ...)
571 E2FSCK_ATTR((format(printf, 2, 3)));
572 extern void e2fsck_read_bitmaps(e2fsck_t ctx);
573 extern void e2fsck_write_bitmaps(e2fsck_t ctx);
574 extern void preenhalt(e2fsck_t ctx);
575 extern char *string_copy(e2fsck_t ctx, const char *str, int len);
576 extern errcode_t e2fsck_zero_blocks(ext2_filsys fs, blk_t blk, int num,
577 blk_t *ret_blk, int *ret_count);
578 extern int fs_proc_check(const char *fs_name);
579 extern int check_for_modules(const char *fs_name);
580 #ifdef RESOURCE_TRACK
581 extern void print_resource_track(e2fsck_t ctx,
583 struct resource_track *track,
585 extern void init_resource_track(struct resource_track *track,
588 #define print_resource_track(ctx, desc, track, channel) do { } while (0)
589 #define init_resource_track(track, channel) do { } while (0)
591 extern int inode_has_valid_blocks(struct ext2_inode *inode);
592 extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
593 struct ext2_inode * inode, const char * proc);
594 extern void e2fsck_read_inode_full(e2fsck_t ctx, unsigned long ino,
595 struct ext2_inode *inode,
596 const int bufsize, const char *proc);
597 extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
598 struct ext2_inode * inode, const char * proc);
599 extern void e2fsck_write_inode_full(e2fsck_t ctx, unsigned long ino,
600 struct ext2_inode * inode, int bufsize,
603 extern void mtrace_print(char *mesg);
605 extern blk64_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs,
606 const char *name, io_manager manager);
607 extern int ext2_file_type(unsigned int mode);
608 extern int write_all(int fd, char *buf, size_t count);
609 void dump_mmp_msg(struct mmp_struct *mmp, const char *msg);
610 errcode_t e2fsck_mmp_update(ext2_filsys fs);
612 extern void e2fsck_set_bitmap_type(ext2_filsys fs,
613 unsigned int default_type,
614 const char *profile_name,
615 unsigned int *old_type);
616 extern errcode_t e2fsck_allocate_inode_bitmap(ext2_filsys fs,
619 const char *profile_name,
620 ext2fs_inode_bitmap *ret);
621 extern errcode_t e2fsck_allocate_block_bitmap(ext2_filsys fs,
624 const char *profile_name,
625 ext2fs_block_bitmap *ret);
626 extern errcode_t e2fsck_allocate_subcluster_bitmap(ext2_filsys fs,
629 const char *profile_name,
630 ext2fs_block_bitmap *ret);
633 extern void e2fsck_clear_progbar(e2fsck_t ctx);
634 extern int e2fsck_simple_progress(e2fsck_t ctx, const char *label,
635 float percent, unsigned int dpynum);
636 #endif /* _E2FSCK_H */