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"
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 * Exit codes used by fsck-type programs
67 #define FSCK_OK 0 /* No errors */
68 #define FSCK_NONDESTRUCT 1 /* File system errors corrected */
69 #define FSCK_REBOOT 2 /* System should be rebooted */
70 #define FSCK_UNCORRECTED 4 /* File system errors left uncorrected */
71 #define FSCK_ERROR 8 /* Operational error */
72 #define FSCK_USAGE 16 /* Usage or syntax error */
73 #define FSCK_CANCELED 32 /* Aborted with a signal or ^C */
74 #define FSCK_LIBRARY 128 /* Shared library error */
77 * The last ext2fs revision level that this version of e2fsck is able to
80 #define E2FSCK_CURRENT_REV 1
83 * The directory information structure; stores directory information
84 * collected in earlier passes, to avoid disk i/o in fetching the
85 * directory information.
88 ext2_ino_t ino; /* Inode number */
89 ext2_ino_t dotdot; /* Parent according to '..' */
90 ext2_ino_t parent; /* Parent according to treewalk */
95 * The indexed directory information structure; stores information for
96 * directories which contain a hash tree index.
99 ext2_ino_t ino; /* Inode number */
100 int numblocks; /* number of blocks */
102 short depth; /* depth of tree */
103 struct dx_dirblock_info *dx_block; /* Array of size numblocks */
106 #define DX_DIRBLOCK_ROOT 1
107 #define DX_DIRBLOCK_LEAF 2
108 #define DX_DIRBLOCK_NODE 3
109 #define DX_DIRBLOCK_CORRUPT 4
110 #define DX_DIRBLOCK_CLEARED 8
112 struct dx_dirblock_info {
117 ext2_dirhash_t min_hash;
118 ext2_dirhash_t max_hash;
119 ext2_dirhash_t node_min_hash;
120 ext2_dirhash_t node_max_hash;
123 #define DX_FLAG_REFERENCED 1
124 #define DX_FLAG_DUP_REF 2
125 #define DX_FLAG_FIRST 4
126 #define DX_FLAG_LAST 8
128 #ifdef RESOURCE_TRACK
130 * This structure is used for keeping track of how much resources have
131 * been used for a particular pass of e2fsck.
133 struct resource_track {
134 struct timeval time_start;
135 struct timeval user_start;
136 struct timeval system_start;
138 unsigned long long bytes_read;
139 unsigned long long bytes_written;
146 #define E2F_OPT_READONLY 0x0001
147 #define E2F_OPT_PREEN 0x0002
148 #define E2F_OPT_YES 0x0004
149 #define E2F_OPT_NO 0x0008
150 #define E2F_OPT_TIME 0x0010
151 #define E2F_OPT_TIME2 0x0020
152 #define E2F_OPT_CHECKBLOCKS 0x0040
153 #define E2F_OPT_DEBUG 0x0080
154 #define E2F_OPT_FORCE 0x0100
155 #define E2F_OPT_WRITECHECK 0x0200
156 #define E2F_OPT_COMPRESS_DIRS 0x0400
161 #define E2F_FLAG_ABORT 0x0001 /* Abort signaled */
162 #define E2F_FLAG_CANCEL 0x0002 /* Cancel signaled */
163 #define E2F_FLAG_SIGNAL_MASK 0x0003
164 #define E2F_FLAG_RESTART 0x0004 /* Restart signaled */
166 #define E2F_FLAG_SETJMP_OK 0x0010 /* Setjmp valid for abort */
168 #define E2F_FLAG_PROG_BAR 0x0020 /* Progress bar on screen */
169 #define E2F_FLAG_PROG_SUPPRESS 0x0040 /* Progress suspended */
170 #define E2F_FLAG_JOURNAL_INODE 0x0080 /* Create a new ext3 journal inode */
171 #define E2F_FLAG_SB_SPECIFIED 0x0100 /* The superblock was explicitly
172 * specified by the user */
173 #define E2F_FLAG_RESTARTED 0x0200 /* E2fsck has been restarted */
174 #define E2F_FLAG_RESIZE_INODE 0x0400 /* Request to recreate resize inode */
175 #define E2F_FLAG_GOT_DEVSIZE 0x0800 /* Device size has been fetched */
178 * Defines for indicating the e2fsck pass number
185 #define E2F_PASS_1B 6
188 * Define the extended attribute refcount structure
190 typedef struct ea_refcount *ext2_refcount_t;
193 * This is the global e2fsck structure.
195 typedef struct e2fsck_struct *e2fsck_t;
197 struct e2fsck_struct {
199 const char *program_name;
200 char *filesystem_name;
203 int flags; /* E2fsck internal flags */
205 blk_t use_superblock; /* sb requested by user */
206 blk_t superblock; /* sb used to open fs */
207 int blocksize; /* blocksize */
208 blk_t num_blocks; /* Total number of blocks */
210 blkid_cache blkid; /* blkid cache */
215 unsigned long abort_code;
217 int (*progress)(e2fsck_t ctx, int pass, unsigned long cur,
220 ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */
221 ext2fs_inode_bitmap inode_bad_map; /* Inodes which are bad somehow */
222 ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */
223 ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */
224 ext2fs_inode_bitmap inode_imagic_map; /* AFS inodes */
225 ext2fs_inode_bitmap inode_reg_map; /* Inodes which are regular files*/
227 ext2fs_block_bitmap block_found_map; /* Blocks which are in use */
228 ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */
229 ext2fs_block_bitmap block_ea_map; /* Blocks which are used by EA's */
234 ext2_icount_t inode_count;
235 ext2_icount_t inode_link_info;
237 ext2_refcount_t refcount;
238 ext2_refcount_t refcount_extra;
241 * Array of flags indicating whether an inode bitmap, block
242 * bitmap, or inode table is invalid
244 int *invalid_inode_bitmap_flag;
245 int *invalid_block_bitmap_flag;
246 int *invalid_inode_table_flag;
247 int invalid_bitmaps; /* There are invalid bitmaps/itable */
255 * For pass1_check_directory and pass1_get_blocks
257 ext2_ino_t stashed_ino;
258 struct ext2_inode *stashed_inode;
261 * Location of the lost and found directory
263 ext2_ino_t lost_and_found;
264 int bad_lost_and_found;
267 * Directory information
269 struct dir_info_db *dir_info;
272 * Indexed directory information
274 int dx_dir_info_count;
275 int dx_dir_info_size;
276 struct dx_dir_info *dx_dir_info;
279 * Directories to hash
281 ext2_u32_list dirs_to_hash;
286 int process_inode_size;
287 int inode_buffer_blocks;
290 * ext3 journal support
292 io_channel journal_io;
295 #ifdef RESOURCE_TRACK
297 * For timing purposes
299 struct resource_track global_rtrack;
303 * How we display the progress update (for unix)
307 int progress_last_percent;
308 unsigned int progress_last_time;
309 int interactive; /* Are we connected directly to a tty? */
310 char start_meta[2], stop_meta[2];
313 __u32 fs_directory_count;
314 __u32 fs_regular_count;
315 __u32 fs_blockdev_count;
316 __u32 fs_chardev_count;
317 __u32 fs_links_count;
318 __u32 fs_symlinks_count;
319 __u32 fs_fast_symlinks_count;
321 __u32 fs_total_count;
322 __u32 fs_badblocks_count;
323 __u32 fs_sockets_count;
329 __u32 fs_ext_attr_inodes;
330 __u32 fs_ext_attr_blocks;
334 time_t time_fudge; /* For working around buggy init scripts */
340 * For the use of callers of the e2fsck functions; not used by
341 * e2fsck functions themselves.
346 /* Used by the region allocation code */
347 typedef __u32 region_addr_t;
348 typedef struct region_struct *region_t;
351 #define strnlen(str, x) e2fsck_strnlen((str),(x))
352 extern int e2fsck_strnlen(const char * s, int count);
356 * Procedure declarations
359 extern void e2fsck_pass1(e2fsck_t ctx);
360 extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf);
361 extern void e2fsck_pass2(e2fsck_t ctx);
362 extern void e2fsck_pass3(e2fsck_t ctx);
363 extern void e2fsck_pass4(e2fsck_t ctx);
364 extern void e2fsck_pass5(e2fsck_t ctx);
367 extern errcode_t e2fsck_allocate_context(e2fsck_t *ret);
368 extern errcode_t e2fsck_reset_context(e2fsck_t ctx);
369 extern void e2fsck_free_context(e2fsck_t ctx);
370 extern int e2fsck_run(e2fsck_t ctx);
374 extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
375 int replace_bad_blocks);
378 extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent);
379 extern void e2fsck_free_dir_info(e2fsck_t ctx);
380 extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
381 extern struct dir_info_iter *e2fsck_dir_info_iter_begin(e2fsck_t ctx);
382 extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx,
383 struct dir_info_iter *);
384 extern void e2fsck_dir_info_iter_end(e2fsck_t ctx, struct dir_info_iter *);
385 extern int e2fsck_dir_info_set_parent(e2fsck_t ctx, ext2_ino_t ino,
387 extern int e2fsck_dir_info_set_dotdot(e2fsck_t ctx, ext2_ino_t ino,
389 extern int e2fsck_dir_info_get_parent(e2fsck_t ctx, ext2_ino_t ino,
391 extern int e2fsck_dir_info_get_dotdot(e2fsck_t ctx, ext2_ino_t ino,
395 extern void e2fsck_add_dx_dir(e2fsck_t ctx, ext2_ino_t ino, int num_blocks);
396 extern struct dx_dir_info *e2fsck_get_dx_dir_info(e2fsck_t ctx, ext2_ino_t ino);
397 extern void e2fsck_free_dx_dir_info(e2fsck_t ctx);
398 extern int e2fsck_get_num_dx_dirinfo(e2fsck_t ctx);
399 extern struct dx_dir_info *e2fsck_dx_dir_info_iter(e2fsck_t ctx, int *control);
402 extern errcode_t ea_refcount_create(int size, ext2_refcount_t *ret);
403 extern void ea_refcount_free(ext2_refcount_t refcount);
404 extern errcode_t ea_refcount_fetch(ext2_refcount_t refcount, blk_t blk,
406 extern errcode_t ea_refcount_increment(ext2_refcount_t refcount,
407 blk_t blk, int *ret);
408 extern errcode_t ea_refcount_decrement(ext2_refcount_t refcount,
409 blk_t blk, int *ret);
410 extern errcode_t ea_refcount_store(ext2_refcount_t refcount,
411 blk_t blk, int count);
412 extern blk_t ext2fs_get_refcount_size(ext2_refcount_t refcount);
413 extern void ea_refcount_intr_begin(ext2_refcount_t refcount);
414 extern blk_t ea_refcount_intr_next(ext2_refcount_t refcount, int *ret);
417 extern const char *ehandler_operation(const char *op);
418 extern void ehandler_init(io_channel channel);
421 extern int e2fsck_check_ext3_journal(e2fsck_t ctx);
422 extern int e2fsck_run_ext3_journal(e2fsck_t ctx);
423 extern void e2fsck_move_ext3_journal(e2fsck_t ctx);
424 extern int e2fsck_fix_ext3_journal_hint(e2fsck_t ctx);
427 extern void e2fsck_setup_tdb_icount(e2fsck_t ctx, int flags,
429 extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int bool);
430 extern int e2fsck_pass1_check_device_inode(ext2_filsys fs,
431 struct ext2_inode *inode);
432 extern int e2fsck_pass1_check_symlink(ext2_filsys fs, ext2_ino_t ino,
433 struct ext2_inode *inode, char *buf);
434 extern void e2fsck_clear_inode(e2fsck_t ctx, ext2_ino_t ino,
435 struct ext2_inode *inode, int restart_flag,
439 extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir,
440 ext2_ino_t ino, char *buf);
443 extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode);
444 extern errcode_t e2fsck_expand_directory(e2fsck_t ctx, ext2_ino_t dir,
445 int num, int gauranteed_size);
446 extern ext2_ino_t e2fsck_get_lost_and_found(e2fsck_t ctx, int fix);
447 extern errcode_t e2fsck_adjust_inode_count(e2fsck_t ctx, ext2_ino_t ino,
452 extern region_t region_create(region_addr_t min, region_addr_t max);
453 extern void region_free(region_t region);
454 extern int region_allocate(region_t region, region_addr_t start, int n);
457 errcode_t e2fsck_rehash_dir(e2fsck_t ctx, ext2_ino_t ino);
458 void e2fsck_rehash_directories(e2fsck_t ctx);
461 void check_super_block(e2fsck_t ctx);
462 int check_backup_super_block(e2fsck_t ctx);
465 extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
466 const char *description);
467 extern int ask(e2fsck_t ctx, const char * string, int def);
468 extern int ask_yn(const char * string, int def);
469 extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
470 extern void e2fsck_read_bitmaps(e2fsck_t ctx);
471 extern void e2fsck_write_bitmaps(e2fsck_t ctx);
472 extern void preenhalt(e2fsck_t ctx);
473 extern char *string_copy(e2fsck_t ctx, const char *str, int len);
474 extern errcode_t e2fsck_zero_blocks(ext2_filsys fs, blk_t blk, int num,
475 blk_t *ret_blk, int *ret_count);
476 #ifdef RESOURCE_TRACK
477 extern void print_resource_track(const char *desc,
478 struct resource_track *track,
480 extern void init_resource_track(struct resource_track *track,
483 extern int inode_has_valid_blocks(struct ext2_inode *inode);
484 extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
485 struct ext2_inode * inode, const char * proc);
486 extern void e2fsck_read_inode_full(e2fsck_t ctx, unsigned long ino,
487 struct ext2_inode *inode,
488 const int bufsize, const char *proc);
489 extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
490 struct ext2_inode * inode, const char * proc);
491 extern void e2fsck_write_inode_full(e2fsck_t ctx, unsigned long ino,
492 struct ext2_inode * inode, int bufsize,
495 extern void mtrace_print(char *mesg);
497 extern blk_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs,
498 const char *name, io_manager manager);
499 extern int ext2_file_type(unsigned int mode);
502 extern void e2fsck_clear_progbar(e2fsck_t ctx);
503 extern int e2fsck_simple_progress(e2fsck_t ctx, const char *label,
504 float percent, unsigned int dpynum);
505 #endif /* _E2FSCK_H */