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 int numblocks; /* number of blocks */
110 short depth; /* depth of tree */
111 struct dx_dirblock_info *dx_block; /* Array of size numblocks */
114 #define DX_DIRBLOCK_ROOT 1
115 #define DX_DIRBLOCK_LEAF 2
116 #define DX_DIRBLOCK_NODE 3
117 #define DX_DIRBLOCK_CORRUPT 4
118 #define DX_DIRBLOCK_CLEARED 8
120 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
171 #define E2F_OPT_CONVERT_BMAP 0x4000 /* convert blockmap to extent */
172 #define E2F_OPT_FIXES_ONLY 0x8000 /* skip all optimizations */
173 #define E2F_OPT_NOOPT_EXTENTS 0x10000 /* don't optimize extents */
178 #define E2F_FLAG_ABORT 0x0001 /* Abort signaled */
179 #define E2F_FLAG_CANCEL 0x0002 /* Cancel signaled */
180 #define E2F_FLAG_SIGNAL_MASK (E2F_FLAG_ABORT | E2F_FLAG_CANCEL)
181 #define E2F_FLAG_RESTART 0x0004 /* Restart signaled */
182 #define E2F_FLAG_RUN_RETURN (E2F_FLAG_SIGNAL_MASK | E2F_FLAG_RESTART)
183 #define E2F_FLAG_RESTART_LATER 0x0008 /* Restart after all iterations done */
184 #define E2F_FLAG_SETJMP_OK 0x0010 /* Setjmp valid for abort */
186 #define E2F_FLAG_PROG_BAR 0x0020 /* Progress bar on screen */
187 #define E2F_FLAG_PROG_SUPPRESS 0x0040 /* Progress suspended */
188 #define E2F_FLAG_JOURNAL_INODE 0x0080 /* Create a new ext3 journal inode */
189 #define E2F_FLAG_SB_SPECIFIED 0x0100 /* The superblock was explicitly
190 * specified by the user */
191 #define E2F_FLAG_RESTARTED 0x0200 /* E2fsck has been restarted */
192 #define E2F_FLAG_RESIZE_INODE 0x0400 /* Request to recreate resize inode */
193 #define E2F_FLAG_GOT_DEVSIZE 0x0800 /* Device size has been fetched */
194 #define E2F_FLAG_EXITING 0x1000 /* E2fsck exiting due to errors */
195 #define E2F_FLAG_TIME_INSANE 0x2000 /* Time is insane */
196 #define E2F_FLAG_PROBLEMS_FIXED 0x4000 /* At least one problem was fixed */
197 #define E2F_FLAG_ALLOC_OK 0x8000 /* Can we allocate blocks? */
199 #define E2F_RESET_FLAGS (E2F_FLAG_TIME_INSANE | E2F_FLAG_PROBLEMS_FIXED)
202 * Defines for indicating the e2fsck pass number
209 #define E2F_PASS_1B 6
212 * Define the extended attribute refcount structure
214 typedef struct ea_refcount *ext2_refcount_t;
217 * This is the global e2fsck structure.
219 typedef struct e2fsck_struct *e2fsck_t;
221 #define MAX_EXTENT_DEPTH_COUNT 5
223 struct e2fsck_struct {
225 const char *program_name;
226 char *filesystem_name;
231 int flags; /* E2fsck internal flags */
233 int blocksize; /* blocksize */
234 blk64_t use_superblock; /* sb requested by user */
235 blk64_t superblock; /* sb used to open fs */
236 blk64_t num_blocks; /* Total number of blocks */
241 blkid_cache blkid; /* blkid cache */
246 unsigned long abort_code;
248 int (*progress)(e2fsck_t ctx, int pass, unsigned long cur,
251 ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */
252 ext2fs_inode_bitmap inode_bad_map; /* Inodes which are bad somehow */
253 ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */
254 ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */
255 ext2fs_inode_bitmap inode_imagic_map; /* AFS inodes */
256 ext2fs_inode_bitmap inode_reg_map; /* Inodes which are regular files*/
258 ext2fs_block_bitmap block_found_map; /* Blocks which are in use */
259 ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */
260 ext2fs_block_bitmap block_ea_map; /* Blocks which are used by EA's */
265 ext2_icount_t inode_count;
266 ext2_icount_t inode_link_info;
268 ext2_refcount_t refcount;
269 ext2_refcount_t refcount_extra;
272 * Quota blocks and inodes to be charged for each ea block.
274 ext2_refcount_t ea_block_quota_blocks;
275 ext2_refcount_t ea_block_quota_inodes;
278 * ea_inode references from attr entries.
280 ext2_refcount_t ea_inode_refs;
283 * Array of flags indicating whether an inode bitmap, block
284 * bitmap, or inode table is invalid
286 int *invalid_inode_bitmap_flag;
287 int *invalid_block_bitmap_flag;
288 int *invalid_inode_table_flag;
289 int invalid_bitmaps; /* There are invalid bitmaps/itable */
297 * For pass1_check_directory and pass1_get_blocks
299 ext2_ino_t stashed_ino;
300 struct ext2_inode *stashed_inode;
303 * Location of the lost and found directory
305 ext2_ino_t lost_and_found;
306 int bad_lost_and_found;
309 * Directory information
311 struct dir_info_db *dir_info;
314 * Indexed directory information
316 int dx_dir_info_count;
317 int dx_dir_info_size;
318 struct dx_dir_info *dx_dir_info;
321 * Directories to hash
323 ext2_u32_list dirs_to_hash;
328 int process_inode_size;
329 int inode_buffer_blocks;
330 unsigned int htree_slack_percentage;
333 * ext3 journal support
335 io_channel journal_io;
342 #ifdef RESOURCE_TRACK
344 * For timing purposes
346 struct resource_track global_rtrack;
350 * How we display the progress update (for unix)
354 int progress_last_percent;
355 unsigned int progress_last_time;
356 int interactive; /* Are we connected directly to a tty? */
357 char start_meta[2], stop_meta[2];
360 __u32 fs_directory_count;
361 __u32 fs_regular_count;
362 __u32 fs_blockdev_count;
363 __u32 fs_chardev_count;
364 __u32 fs_links_count;
365 __u32 fs_symlinks_count;
366 __u32 fs_fast_symlinks_count;
368 __u32 fs_total_count;
369 __u32 fs_badblocks_count;
370 __u32 fs_sockets_count;
375 __u32 fs_fragmented_dir;
377 __u32 fs_ext_attr_inodes;
378 __u32 fs_ext_attr_blocks;
379 __u32 extent_depth_count[MAX_EXTENT_DEPTH_COUNT];
383 time_t time_fudge; /* For working around buggy init scripts */
387 ext2_u32_list encrypted_dirs;
389 /* Reserve blocks for root and l+f re-creation */
390 blk64_t root_repair_block, lnf_repair_block;
393 * For the use of callers of the e2fsck functions; not used by
394 * e2fsck functions themselves.
397 ext2fs_block_bitmap block_metadata_map; /* Metadata blocks */
399 /* How much are we allowed to readahead? */
400 unsigned long long readahead_kb;
403 * Inodes to rebuild extent trees
405 ext2fs_inode_bitmap inodes_to_rebuild;
411 /* Data structures to evaluate whether an extent tree needs rebuilding. */
412 struct extent_tree_level {
413 unsigned int num_extents;
414 unsigned int max_extents;
417 struct extent_tree_info {
420 struct extent_tree_level ext_info[MAX_EXTENT_DEPTH_COUNT];
423 /* Used by the region allocation code */
424 typedef __u64 region_addr_t;
425 typedef struct region_struct *region_t;
428 #define strnlen(str, x) e2fsck_strnlen((str),(x))
429 extern int e2fsck_strnlen(const char * s, int count);
433 * Procedure declarations
436 extern void e2fsck_pass1(e2fsck_t ctx);
437 extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf);
438 extern void e2fsck_pass2(e2fsck_t ctx);
439 extern void e2fsck_pass3(e2fsck_t ctx);
440 extern void e2fsck_pass4(e2fsck_t ctx);
441 extern void e2fsck_pass5(e2fsck_t ctx);
444 extern errcode_t e2fsck_allocate_context(e2fsck_t *ret);
445 extern errcode_t e2fsck_reset_context(e2fsck_t ctx);
446 extern void e2fsck_free_context(e2fsck_t ctx);
447 extern int e2fsck_run(e2fsck_t ctx);
451 extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
452 int replace_bad_blocks);
455 extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent);
456 extern void e2fsck_free_dir_info(e2fsck_t ctx);
457 extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
458 extern struct dir_info_iter *e2fsck_dir_info_iter_begin(e2fsck_t ctx);
459 extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx,
460 struct dir_info_iter *);
461 extern void e2fsck_dir_info_iter_end(e2fsck_t ctx, struct dir_info_iter *);
462 extern int e2fsck_dir_info_set_parent(e2fsck_t ctx, ext2_ino_t ino,
464 extern int e2fsck_dir_info_set_dotdot(e2fsck_t ctx, ext2_ino_t ino,
466 extern int e2fsck_dir_info_get_parent(e2fsck_t ctx, ext2_ino_t ino,
468 extern int e2fsck_dir_info_get_dotdot(e2fsck_t ctx, ext2_ino_t ino,
472 extern void e2fsck_add_dx_dir(e2fsck_t ctx, ext2_ino_t ino, int num_blocks);
473 extern struct dx_dir_info *e2fsck_get_dx_dir_info(e2fsck_t ctx, ext2_ino_t ino);
474 extern void e2fsck_free_dx_dir_info(e2fsck_t ctx);
475 extern int e2fsck_get_num_dx_dirinfo(e2fsck_t ctx);
476 extern struct dx_dir_info *e2fsck_dx_dir_info_iter(e2fsck_t ctx, int *control);
479 typedef __u64 ea_key_t;
480 typedef __u64 ea_value_t;
482 extern errcode_t ea_refcount_create(size_t size, ext2_refcount_t *ret);
483 extern void ea_refcount_free(ext2_refcount_t refcount);
484 extern errcode_t ea_refcount_fetch(ext2_refcount_t refcount, ea_key_t ea_key,
486 extern errcode_t ea_refcount_increment(ext2_refcount_t refcount,
487 ea_key_t ea_key, ea_value_t *ret);
488 extern errcode_t ea_refcount_decrement(ext2_refcount_t refcount,
489 ea_key_t ea_key, ea_value_t *ret);
490 extern errcode_t ea_refcount_store(ext2_refcount_t refcount, ea_key_t ea_key,
492 extern size_t ext2fs_get_refcount_size(ext2_refcount_t refcount);
493 extern void ea_refcount_intr_begin(ext2_refcount_t refcount);
494 extern ea_key_t ea_refcount_intr_next(ext2_refcount_t refcount,
498 extern const char *ehandler_operation(const char *op);
499 extern void ehandler_init(io_channel channel);
502 struct problem_context;
503 errcode_t e2fsck_rebuild_extents_later(e2fsck_t ctx, ext2_ino_t ino);
504 int e2fsck_ino_will_be_rebuilt(e2fsck_t ctx, ext2_ino_t ino);
505 void e2fsck_pass1e(e2fsck_t ctx);
506 errcode_t e2fsck_check_rebuild_extents(e2fsck_t ctx, ext2_ino_t ino,
507 struct ext2_inode *inode,
508 struct problem_context *pctx);
509 errcode_t e2fsck_should_rebuild_extents(e2fsck_t ctx,
510 struct problem_context *pctx,
511 struct extent_tree_info *eti,
512 struct ext2_extent_info *info);
515 extern errcode_t e2fsck_check_ext3_journal(e2fsck_t ctx);
516 extern errcode_t e2fsck_run_ext3_journal(e2fsck_t ctx);
517 extern void e2fsck_move_ext3_journal(e2fsck_t ctx);
518 extern int e2fsck_fix_ext3_journal_hint(e2fsck_t ctx);
521 extern void set_up_logging(e2fsck_t ctx);
524 extern void e2fsck_hide_quota(e2fsck_t ctx);
527 extern errcode_t e2fsck_setup_icount(e2fsck_t ctx, const char *icount_name,
528 int flags, ext2_icount_t hint,
530 extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int use_shortcuts);
531 extern int e2fsck_pass1_check_device_inode(ext2_filsys fs,
532 struct ext2_inode *inode);
533 extern int e2fsck_pass1_check_symlink(ext2_filsys fs, ext2_ino_t ino,
534 struct ext2_inode *inode, char *buf);
535 extern void e2fsck_clear_inode(e2fsck_t ctx, ext2_ino_t ino,
536 struct ext2_inode *inode, int restart_flag,
538 extern void e2fsck_intercept_block_allocations(e2fsck_t ctx);
541 extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir,
542 ext2_ino_t ino, char *buf);
543 extern int get_filename_hash(ext2_filsys fs, int encrypted, int version,
544 const char *name, int len,
545 ext2_dirhash_t *ret_hash,
546 ext2_dirhash_t *ret_minor_hash);
549 extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode);
550 extern errcode_t e2fsck_expand_directory(e2fsck_t ctx, ext2_ino_t dir,
551 int num, int gauranteed_size);
552 extern ext2_ino_t e2fsck_get_lost_and_found(e2fsck_t ctx, int fix);
553 extern errcode_t e2fsck_adjust_inode_count(e2fsck_t ctx, ext2_ino_t ino,
557 #define E2FSCK_READA_SUPER (0x01)
558 #define E2FSCK_READA_GDT (0x02)
559 #define E2FSCK_READA_BBITMAP (0x04)
560 #define E2FSCK_READA_IBITMAP (0x08)
561 #define E2FSCK_READA_ITABLE (0x10)
562 #define E2FSCK_READA_ALL_FLAGS (0x1F)
563 errcode_t e2fsck_readahead(ext2_filsys fs, int flags, dgrp_t start,
565 #define E2FSCK_RA_DBLIST_IGNORE_BLOCKCNT (0x01)
566 #define E2FSCK_RA_DBLIST_ALL_FLAGS (0x01)
567 errcode_t e2fsck_readahead_dblist(ext2_filsys fs, int flags,
569 unsigned long long start,
570 unsigned long long count);
571 int e2fsck_can_readahead(ext2_filsys fs);
572 unsigned long long e2fsck_guess_readahead(ext2_filsys fs);
575 extern region_t region_create(region_addr_t min, region_addr_t max);
576 extern void region_free(region_t region);
577 extern int region_allocate(region_t region, region_addr_t start, int n);
580 void e2fsck_rehash_dir_later(e2fsck_t ctx, ext2_ino_t ino);
581 int e2fsck_dir_will_be_rehashed(e2fsck_t ctx, ext2_ino_t ino);
582 errcode_t e2fsck_rehash_dir(e2fsck_t ctx, ext2_ino_t ino,
583 struct problem_context *pctx);
584 void e2fsck_rehash_directories(e2fsck_t ctx);
587 void sigcatcher_setup(void);
590 void check_super_block(e2fsck_t ctx);
591 int check_backup_super_block(e2fsck_t ctx);
592 void check_resize_inode(e2fsck_t ctx);
595 extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
596 const char *description);
597 extern int ask(e2fsck_t ctx, const char * string, int def);
598 extern int ask_yn(e2fsck_t ctx, const char * string, int def);
599 extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
600 extern void log_out(e2fsck_t ctx, const char *fmt, ...)
601 E2FSCK_ATTR((format(printf, 2, 3)));
602 extern void log_err(e2fsck_t ctx, const char *fmt, ...)
603 E2FSCK_ATTR((format(printf, 2, 3)));
604 extern void e2fsck_read_bitmaps(e2fsck_t ctx);
605 extern void e2fsck_write_bitmaps(e2fsck_t ctx);
606 extern void preenhalt(e2fsck_t ctx);
607 extern char *string_copy(e2fsck_t ctx, const char *str, int len);
608 extern int fs_proc_check(const char *fs_name);
609 extern int check_for_modules(const char *fs_name);
610 #ifdef RESOURCE_TRACK
611 extern void print_resource_track(e2fsck_t ctx,
613 struct resource_track *track,
615 extern void init_resource_track(struct resource_track *track,
618 #define print_resource_track(ctx, desc, track, channel) do { } while (0)
619 #define init_resource_track(track, channel) do { } while (0)
621 extern int inode_has_valid_blocks(struct ext2_inode *inode);
622 extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
623 struct ext2_inode * inode, const char * proc);
624 extern void e2fsck_read_inode_full(e2fsck_t ctx, unsigned long ino,
625 struct ext2_inode *inode,
626 const int bufsize, const char *proc);
627 extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
628 struct ext2_inode * inode, const char * proc);
629 extern void e2fsck_write_inode_full(e2fsck_t ctx, unsigned long ino,
630 struct ext2_inode * inode, int bufsize,
633 extern void mtrace_print(char *mesg);
635 extern blk64_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs,
636 const char *name, io_manager manager);
637 extern int ext2_file_type(unsigned int mode);
638 extern int write_all(int fd, char *buf, size_t count);
639 void dump_mmp_msg(struct mmp_struct *mmp, const char *msg);
640 errcode_t e2fsck_mmp_update(ext2_filsys fs);
642 extern void e2fsck_set_bitmap_type(ext2_filsys fs,
643 unsigned int default_type,
644 const char *profile_name,
645 unsigned int *old_type);
646 extern errcode_t e2fsck_allocate_inode_bitmap(ext2_filsys fs,
649 const char *profile_name,
650 ext2fs_inode_bitmap *ret);
651 extern errcode_t e2fsck_allocate_block_bitmap(ext2_filsys fs,
654 const char *profile_name,
655 ext2fs_block_bitmap *ret);
656 extern errcode_t e2fsck_allocate_subcluster_bitmap(ext2_filsys fs,
659 const char *profile_name,
660 ext2fs_block_bitmap *ret);
661 unsigned long long get_memory_size(void);
664 extern void e2fsck_clear_progbar(e2fsck_t ctx);
665 extern int e2fsck_simple_progress(e2fsck_t ctx, const char *label,
666 float percent, unsigned int dpynum);
668 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
670 #endif /* _E2FSCK_H */