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/mkquota.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_EXPAND_EISIZE 0x4000 /* Expand the inodes (i_extra_isize) */
195 #define E2F_RESET_FLAGS (E2F_FLAG_TIME_INSANE)
198 * Defines for indicating the e2fsck pass number
205 #define E2F_PASS_1B 6
208 E2F_SHARED_PRESERVE = 0,
218 #define EXT4_FITS_IN_INODE(ext4_inode, einode, field) \
219 ((offsetof(typeof(*ext4_inode), field) + \
220 sizeof(ext4_inode->field)) <= \
221 (EXT2_GOOD_OLD_INODE_SIZE + \
222 (einode)->i_extra_isize)) \
224 #define EXT4_XTIME_FUTURE(ctx, sb, xtime, margin) \
225 (!((ctx)->flags & E2F_FLAG_TIME_INSANE) && \
226 (xtime) > (ctx)->now + (margin))
227 #define EXT4_XTIME_ANCIENT(ctx, sb, xtime, margin) \
228 ((sb)->s_mkfs_time > (margin) && (xtime) < (sb)->s_mkfs_time - (margin))
230 #define BADNESS_NORMAL 1
231 #define BADNESS_HIGH 2
232 #define BADNESS_THRESHOLD 8
233 #define BADNESS_BAD_MODE 100
234 #define BADNESS_LARGE_FILE 2199023255552ULL
237 * Define the extended attribute refcount structure
239 typedef struct ea_refcount *ext2_refcount_t;
242 * This is the global e2fsck structure.
244 typedef struct e2fsck_struct *e2fsck_t;
246 #define MAX_EXTENT_DEPTH_COUNT 5
248 struct e2fsck_struct {
250 const char *program_name;
251 char *filesystem_name;
256 int flags; /* E2fsck internal flags */
258 int blocksize; /* blocksize */
259 blk64_t use_superblock; /* sb requested by user */
260 blk64_t superblock; /* sb used to open fs */
261 blk64_t num_blocks; /* Total number of blocks */
265 blkid_cache blkid; /* blkid cache */
270 unsigned long abort_code;
272 int (*progress)(e2fsck_t ctx, int pass, unsigned long cur,
275 ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */
276 ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */
277 ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */
278 ext2fs_inode_bitmap inode_imagic_map; /* AFS inodes */
279 ext2fs_inode_bitmap inode_reg_map; /* Inodes which are regular files*/
280 ext2fs_inode_bitmap inode_ea_map; /* EA inodes which are non-orphan */
282 ext2fs_block_bitmap block_found_map; /* Blocks which are in use */
283 ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */
284 ext2fs_block_bitmap block_ea_map; /* Blocks which are used by EA's */
289 ext2_icount_t inode_count;
290 ext2_icount_t inode_link_info;
291 ext2_icount_t inode_badness;
292 int inode_badness_threshold;
294 ext2_refcount_t refcount;
295 ext2_refcount_t refcount_extra;
298 * Array of flags indicating whether an inode bitmap, block
299 * bitmap, or inode table is invalid
301 int *invalid_inode_bitmap_flag;
302 int *invalid_block_bitmap_flag;
303 int *invalid_inode_table_flag;
304 int invalid_bitmaps; /* There are invalid bitmaps/itable */
312 * For pass1_check_directory and pass1_get_blocks
314 ext2_ino_t stashed_ino;
315 struct ext2_inode *stashed_inode;
318 * Location of the lost and found directory
320 ext2_ino_t lost_and_found;
321 int bad_lost_and_found;
324 * Directory information
326 struct dir_info_db *dir_info;
329 * Indexed directory information
331 int dx_dir_info_count;
332 int dx_dir_info_size;
333 struct dx_dir_info *dx_dir_info;
336 * Directories to hash
338 ext2_u32_list dirs_to_hash;
343 int process_inode_size;
344 int inode_buffer_blocks;
345 unsigned int htree_slack_percentage;
348 * ext3 journal support
350 io_channel journal_io;
357 #ifdef RESOURCE_TRACK
359 * For timing purposes
361 struct resource_track global_rtrack;
365 * How we display the progress update (for unix)
369 int progress_last_percent;
370 unsigned int progress_last_time;
371 int interactive; /* Are we connected directly to a tty? */
372 char start_meta[2], stop_meta[2];
375 __u32 fs_directory_count;
376 __u32 fs_regular_count;
377 __u32 fs_blockdev_count;
378 __u32 fs_chardev_count;
379 __u32 fs_links_count;
380 __u32 fs_symlinks_count;
381 __u32 fs_fast_symlinks_count;
383 __u32 fs_total_count;
384 __u32 fs_badblocks_count;
385 __u32 fs_sockets_count;
390 __u32 fs_fragmented_dir;
392 __u32 fs_ext_attr_inodes;
393 __u32 fs_ext_attr_blocks;
394 __u32 extent_depth_count[MAX_EXTENT_DEPTH_COUNT];
398 time_t time_fudge; /* For working around buggy init scripts */
400 enum shared_opt shared;
401 enum clone_opt clone;
405 /* Expand large inodes to atleast these many bytes */
406 int want_extra_isize;
407 /* minimum i_extra_isize found in used inodes. Should not be lesser
408 * than s_min_extra_isize.
410 __u32 min_extra_isize;
411 int fs_unexpanded_inodes;
412 ext2fs_inode_bitmap expand_eisize_map;
415 * For the use of callers of the e2fsck functions; not used by
416 * e2fsck functions themselves.
421 /* Used by the region allocation code */
422 typedef __u32 region_addr_t;
423 typedef struct region_struct *region_t;
426 #define strnlen(str, x) e2fsck_strnlen((str),(x))
427 extern int e2fsck_strnlen(const char * s, int count);
431 * Procedure declarations
434 extern void e2fsck_pass1(e2fsck_t ctx);
435 extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf);
436 extern void e2fsck_pass2(e2fsck_t ctx);
437 extern void e2fsck_pass3(e2fsck_t ctx);
438 extern void e2fsck_pass4(e2fsck_t ctx);
439 extern void e2fsck_pass5(e2fsck_t ctx);
442 extern errcode_t e2fsck_allocate_context(e2fsck_t *ret);
443 extern errcode_t e2fsck_reset_context(e2fsck_t ctx);
444 extern void e2fsck_free_context(e2fsck_t ctx);
445 extern int e2fsck_run(e2fsck_t ctx);
449 extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
450 int replace_bad_blocks);
453 extern __u32 crc32_be(__u32 crc, unsigned char const *p, size_t len);
456 extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent);
457 extern void e2fsck_free_dir_info(e2fsck_t ctx);
458 extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
459 extern struct dir_info_iter *e2fsck_dir_info_iter_begin(e2fsck_t ctx);
460 extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx,
461 struct dir_info_iter *);
462 extern void e2fsck_dir_info_iter_end(e2fsck_t ctx, struct dir_info_iter *);
463 extern int e2fsck_dir_info_set_parent(e2fsck_t ctx, ext2_ino_t ino,
465 extern int e2fsck_dir_info_set_dotdot(e2fsck_t ctx, ext2_ino_t ino,
467 extern int e2fsck_dir_info_get_parent(e2fsck_t ctx, ext2_ino_t ino,
469 extern int e2fsck_dir_info_get_dotdot(e2fsck_t ctx, ext2_ino_t ino,
473 extern void e2fsck_add_dx_dir(e2fsck_t ctx, ext2_ino_t ino, int num_blocks);
474 extern struct dx_dir_info *e2fsck_get_dx_dir_info(e2fsck_t ctx, ext2_ino_t ino);
475 extern void e2fsck_free_dx_dir_info(e2fsck_t ctx);
476 extern int e2fsck_get_num_dx_dirinfo(e2fsck_t ctx);
477 extern struct dx_dir_info *e2fsck_dx_dir_info_iter(e2fsck_t ctx, int *control);
480 extern errcode_t ea_refcount_create(int size, ext2_refcount_t *ret);
481 extern void ea_refcount_free(ext2_refcount_t refcount);
482 extern errcode_t ea_refcount_fetch(ext2_refcount_t refcount, blk_t blk,
484 extern errcode_t ea_refcount_increment(ext2_refcount_t refcount,
485 blk_t blk, int *ret);
486 extern errcode_t ea_refcount_decrement(ext2_refcount_t refcount,
487 blk_t blk, int *ret);
488 extern errcode_t ea_refcount_store(ext2_refcount_t refcount,
489 blk_t blk, int count);
490 extern blk_t ext2fs_get_refcount_size(ext2_refcount_t refcount);
491 extern void ea_refcount_intr_begin(ext2_refcount_t refcount);
492 extern blk_t ea_refcount_intr_next(ext2_refcount_t refcount, int *ret);
495 extern const char *ehandler_operation(const char *op);
496 extern void ehandler_init(io_channel channel);
499 extern int e2fsck_check_ext3_journal(e2fsck_t ctx);
500 extern int e2fsck_run_ext3_journal(e2fsck_t ctx);
501 extern void e2fsck_move_ext3_journal(e2fsck_t ctx);
502 extern int e2fsck_fix_ext3_journal_hint(e2fsck_t ctx);
505 extern void set_up_logging(e2fsck_t ctx);
508 extern void e2fsck_hide_quota(e2fsck_t ctx);
511 extern void e2fsck_setup_tdb_icount(e2fsck_t ctx, int flags,
513 extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int bool);
514 extern int e2fsck_pass1_check_device_inode(ext2_filsys fs,
515 struct ext2_inode *inode);
516 extern int e2fsck_pass1_check_symlink(ext2_filsys fs, ext2_ino_t ino,
517 struct ext2_inode *inode, char *buf);
518 extern void e2fsck_clear_inode(e2fsck_t ctx, ext2_ino_t ino,
519 struct ext2_inode *inode, int restart_flag,
521 #define e2fsck_mark_inode_bad(ctx, ino, count) \
522 e2fsck_mark_inode_bad_loc(ctx, ino, count, __func__, __LINE__)
523 extern void e2fsck_mark_inode_bad_loc(e2fsck_t ctx, ino_t ino, int count,
524 const char *func, const int line);
525 extern int is_inode_bad(e2fsck_t ctx, ino_t ino);
528 extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir,
529 ext2_ino_t ino, char *buf);
532 extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode);
533 extern errcode_t e2fsck_expand_directory(e2fsck_t ctx, ext2_ino_t dir,
534 int num, int gauranteed_size);
535 extern ext2_ino_t e2fsck_get_lost_and_found(e2fsck_t ctx, int fix);
536 extern errcode_t e2fsck_adjust_inode_count(e2fsck_t ctx, ext2_ino_t ino,
541 extern region_t region_create(region_addr_t min, region_addr_t max);
542 extern void region_free(region_t region);
543 extern int region_allocate(region_t region, region_addr_t start, int n);
546 errcode_t e2fsck_rehash_dir(e2fsck_t ctx, ext2_ino_t ino);
547 void e2fsck_rehash_directories(e2fsck_t ctx);
550 void sigcatcher_setup(void);
553 void check_super_block(e2fsck_t ctx);
554 int check_backup_super_block(e2fsck_t ctx);
555 void check_resize_inode(e2fsck_t ctx);
558 extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
559 const char *description);
560 extern int ask(e2fsck_t ctx, const char * string, int def);
561 extern int ask_yn(e2fsck_t ctx, const char * string, int def);
562 extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
563 extern void log_out(e2fsck_t ctx, const char *fmt, ...)
564 E2FSCK_ATTR((format(printf, 2, 3)));
565 extern void log_err(e2fsck_t ctx, const char *fmt, ...)
566 E2FSCK_ATTR((format(printf, 2, 3)));
567 extern void e2fsck_read_bitmaps(e2fsck_t ctx);
568 extern void e2fsck_write_bitmaps(e2fsck_t ctx);
569 extern void preenhalt(e2fsck_t ctx);
570 extern char *string_copy(e2fsck_t ctx, const char *str, int len);
571 extern errcode_t e2fsck_zero_blocks(ext2_filsys fs, blk_t blk, int num,
572 blk_t *ret_blk, int *ret_count);
573 extern int fs_proc_check(const char *fs_name);
574 extern int check_for_modules(const char *fs_name);
575 #ifdef RESOURCE_TRACK
576 extern void print_resource_track(e2fsck_t ctx,
578 struct resource_track *track,
580 extern void init_resource_track(struct resource_track *track,
583 #define print_resource_track(ctx, desc, track, channel) do { } while (0)
584 #define init_resource_track(track, channel) do { } while (0)
586 extern int inode_has_valid_blocks(struct ext2_inode *inode);
587 extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
588 struct ext2_inode * inode, const char * proc);
589 extern void e2fsck_read_inode_full(e2fsck_t ctx, unsigned long ino,
590 struct ext2_inode *inode,
591 const int bufsize, const char *proc);
592 extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
593 struct ext2_inode * inode, const char * proc);
594 extern void e2fsck_write_inode_full(e2fsck_t ctx, unsigned long ino,
595 struct ext2_inode * inode, int bufsize,
598 extern void mtrace_print(char *mesg);
600 extern blk_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs,
601 const char *name, io_manager manager);
602 extern int ext2_file_type(unsigned int mode);
603 extern int write_all(int fd, char *buf, size_t count);
604 void dump_mmp_msg(struct mmp_struct *mmp, const char *msg);
605 errcode_t e2fsck_mmp_update(ext2_filsys fs);
607 extern void e2fsck_set_bitmap_type(ext2_filsys fs,
608 unsigned int default_type,
609 const char *profile_name,
610 unsigned int *old_type);
611 extern errcode_t e2fsck_allocate_inode_bitmap(ext2_filsys fs,
614 const char *profile_name,
615 ext2fs_inode_bitmap *ret);
616 extern errcode_t e2fsck_allocate_block_bitmap(ext2_filsys fs,
619 const char *profile_name,
620 ext2fs_block_bitmap *ret);
621 extern errcode_t e2fsck_allocate_subcluster_bitmap(ext2_filsys fs,
624 const char *profile_name,
625 ext2fs_block_bitmap *ret);
628 extern void e2fsck_clear_progbar(e2fsck_t ctx);
629 extern int e2fsck_simple_progress(e2fsck_t ctx, const char *label,
630 float percent, unsigned int dpynum);
631 #endif /* _E2FSCK_H */