1 /* 2 * e2fsck.h 3 * 4 * Copyright (C) 1993, 1994 Theodore Ts'o. This file may be 5 * redistributed under the terms of the GNU Public License. 6 * 7 */ 8 9 #ifndef _E2FSCK_H 10 #define _E2FSCK_H 11 12 #include <stdio.h> 13 #include <string.h> 14 #ifdef HAVE_UNISTD_H 15 #include <unistd.h> 16 #endif 17 #include <stdlib.h> 18 #include <time.h> 19 #ifdef HAVE_SYS_TYPES_H 20 #include <sys/types.h> 21 #endif 22 #ifdef HAVE_SYS_TIME_H 23 #include <sys/time.h> 24 #endif 25 #ifdef HAVE_SETJMP_H 26 #include <setjmp.h> 27 #endif 28 29 #if EXT2_FLAT_INCLUDES 30 #include "ext2_fs.h" 31 #include "ext2fs.h" 32 #include "blkid.h" 33 #else 34 #include "ext2fs/ext2_fs.h" 35 #include "ext2fs/ext2fs.h" 36 #include "blkid/blkid.h" 37 #endif 38 39 #include "profile.h" 40 #include "prof_err.h" 41 42 #ifdef ENABLE_NLS 43 #include <libintl.h> 44 #include <locale.h> 45 #define _(a) (gettext (a)) 46 #ifdef gettext_noop 47 #define N_(a) gettext_noop (a) 48 #else 49 #define N_(a) (a) 50 #endif 51 #define P_(singular, plural, n) (ngettext (singular, plural, n)) 52 #ifndef NLS_CAT_NAME 53 #define NLS_CAT_NAME "e2fsprogs" 54 #endif 55 #ifndef LOCALEDIR 56 #define LOCALEDIR "/usr/share/locale" 57 #endif 58 #else 59 #define _(a) (a) 60 #define N_(a) a 61 #define P_(singular, plural, n) ((n) == 1 ? (singular) : (plural)) 62 #endif 63 64 /* 65 * Exit codes used by fsck-type programs 66 */ 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 */ 75 76 /* 77 * The last ext2fs revision level that this version of e2fsck is able to 78 * support 79 */ 80 #define E2FSCK_CURRENT_REV 1 81 82 /* 83 * The directory information structure; stores directory information 84 * collected in earlier passes, to avoid disk i/o in fetching the 85 * directory information. 86 */ 87 struct dir_info { 88 ext2_ino_t ino; /* Inode number */ 89 ext2_ino_t dotdot; /* Parent according to '..' */ 90 ext2_ino_t parent; /* Parent according to treewalk */ 91 }; 92 93 94 /* 95 * The indexed directory information structure; stores information for 96 * directories which contain a hash tree index. 97 */ 98 struct dx_dir_info { 99 ext2_ino_t ino; /* Inode number */ 100 int numblocks; /* number of blocks */ 101 int hashversion; 102 short depth; /* depth of tree */ 103 struct dx_dirblock_info *dx_block; /* Array of size numblocks */ 104 }; 105 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 111 112 struct dx_dirblock_info { 113 int type; 114 blk_t phys; 115 int flags; 116 blk_t parent; 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; 121 }; 122 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 127 128 #ifdef RESOURCE_TRACK 129 /* 130 * This structure is used for keeping track of how much resources have 131 * been used for a particular pass of e2fsck. 132 */ 133 struct resource_track { 134 struct timeval time_start; 135 struct timeval user_start; 136 struct timeval system_start; 137 void *brk_start; 138 unsigned long long bytes_read; 139 unsigned long long bytes_written; 140 }; 141 #endif 142 143 /* 144 * E2fsck options 145 */ 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 157 #define E2F_OPT_FRAGCHECK 0x0800 158 159 /* 160 * E2fsck flags 161 */ 162 #define E2F_FLAG_ABORT 0x0001 /* Abort signaled */ 163 #define E2F_FLAG_CANCEL 0x0002 /* Cancel signaled */ 164 #define E2F_FLAG_SIGNAL_MASK 0x0003 165 #define E2F_FLAG_RESTART 0x0004 /* Restart signaled */ 166 #define E2F_FLAG_RESTART_LATER 0x0008 /* Restart after all iterations done */ 167 168 #define E2F_FLAG_SETJMP_OK 0x0010 /* Setjmp valid for abort */ 169 170 #define E2F_FLAG_PROG_BAR 0x0020 /* Progress bar on screen */ 171 #define E2F_FLAG_PROG_SUPPRESS 0x0040 /* Progress suspended */ 172 #define E2F_FLAG_JOURNAL_INODE 0x0080 /* Create a new ext3 journal inode */ 173 #define E2F_FLAG_SB_SPECIFIED 0x0100 /* The superblock was explicitly 174 * specified by the user */ 175 #define E2F_FLAG_RESTARTED 0x0200 /* E2fsck has been restarted */ 176 #define E2F_FLAG_RESIZE_INODE 0x0400 /* Request to recreate resize inode */ 177 #define E2F_FLAG_GOT_DEVSIZE 0x0800 /* Device size has been fetched */ 178 #define E2F_FLAG_EXITING 0x1000 /* E2fsck exiting due to errors */ 179 180 /* 181 * Defines for indicating the e2fsck pass number 182 */ 183 #define E2F_PASS_1 1 184 #define E2F_PASS_2 2 185 #define E2F_PASS_3 3 186 #define E2F_PASS_4 4 187 #define E2F_PASS_5 5 188 #define E2F_PASS_1B 6 189 190 /* 191 * Define the extended attribute refcount structure 192 */ 193 typedef struct ea_refcount *ext2_refcount_t; 194 195 /* 196 * This is the global e2fsck structure. 197 */ 198 typedef struct e2fsck_struct *e2fsck_t; 199 200 #define MAX_EXTENT_DEPTH_COUNT 5 201 202 struct e2fsck_struct { 203 ext2_filsys fs; 204 const char *program_name; 205 char *filesystem_name; 206 char *device_name; 207 char *io_options; 208 int flags; /* E2fsck internal flags */ 209 int options; 210 blk_t use_superblock; /* sb requested by user */ 211 blk_t superblock; /* sb used to open fs */ 212 int blocksize; /* blocksize */ 213 blk64_t num_blocks; /* Total number of blocks */ 214 int mount_flags; 215 blkid_cache blkid; /* blkid cache */ 216 217 #ifdef HAVE_SETJMP_H 218 jmp_buf abort_loc; 219 #endif 220 unsigned long abort_code; 221 222 int (*progress)(e2fsck_t ctx, int pass, unsigned long cur, 223 unsigned long max); 224 225 ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */ 226 ext2fs_inode_bitmap inode_bad_map; /* Inodes which are bad somehow */ 227 ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */ 228 ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */ 229 ext2fs_inode_bitmap inode_imagic_map; /* AFS inodes */ 230 ext2fs_inode_bitmap inode_reg_map; /* Inodes which are regular files*/ 231 232 ext2fs_block_bitmap block_found_map; /* Blocks which are in use */ 233 ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */ 234 ext2fs_block_bitmap block_ea_map; /* Blocks which are used by EA's */ 235 236 /* 237 * Inode count arrays 238 */ 239 ext2_icount_t inode_count; 240 ext2_icount_t inode_link_info; 241 242 ext2_refcount_t refcount; 243 ext2_refcount_t refcount_extra; 244 245 /* 246 * Array of flags indicating whether an inode bitmap, block 247 * bitmap, or inode table is invalid 248 */ 249 int *invalid_inode_bitmap_flag; 250 int *invalid_block_bitmap_flag; 251 int *invalid_inode_table_flag; 252 int invalid_bitmaps; /* There are invalid bitmaps/itable */ 253 254 /* 255 * Block buffer 256 */ 257 char *block_buf; 258 259 /* 260 * For pass1_check_directory and pass1_get_blocks 261 */ 262 ext2_ino_t stashed_ino; 263 struct ext2_inode *stashed_inode; 264 265 /* 266 * Location of the lost and found directory 267 */ 268 ext2_ino_t lost_and_found; 269 int bad_lost_and_found; 270 271 /* 272 * Directory information 273 */ 274 struct dir_info_db *dir_info; 275 276 /* 277 * Indexed directory information 278 */ 279 int dx_dir_info_count; 280 int dx_dir_info_size; 281 struct dx_dir_info *dx_dir_info; 282 283 /* 284 * Directories to hash 285 */ 286 ext2_u32_list dirs_to_hash; 287 288 /* 289 * Tuning parameters 290 */ 291 int process_inode_size; 292 int inode_buffer_blocks; 293 unsigned int htree_slack_percentage; 294 295 /* 296 * ext3 journal support 297 */ 298 io_channel journal_io; 299 char *journal_name; 300 301 #ifdef RESOURCE_TRACK 302 /* 303 * For timing purposes 304 */ 305 struct resource_track global_rtrack; 306 #endif 307 308 /* 309 * How we display the progress update (for unix) 310 */ 311 int progress_fd; 312 int progress_pos; 313 int progress_last_percent; 314 unsigned int progress_last_time; 315 int interactive; /* Are we connected directly to a tty? */ 316 char start_meta[2], stop_meta[2]; 317 318 /* File counts */ 319 __u32 fs_directory_count; 320 __u32 fs_regular_count; 321 __u32 fs_blockdev_count; 322 __u32 fs_chardev_count; 323 __u32 fs_links_count; 324 __u32 fs_symlinks_count; 325 __u32 fs_fast_symlinks_count; 326 __u32 fs_fifo_count; 327 __u32 fs_total_count; 328 __u32 fs_badblocks_count; 329 __u32 fs_sockets_count; 330 __u32 fs_ind_count; 331 __u32 fs_dind_count; 332 __u32 fs_tind_count; 333 __u32 fs_fragmented; 334 __u32 fs_fragmented_dir; 335 __u32 large_files; 336 __u32 fs_ext_attr_inodes; 337 __u32 fs_ext_attr_blocks; 338 __u32 extent_depth_count[MAX_EXTENT_DEPTH_COUNT]; 339 340 /* misc fields */ 341 time_t now; 342 time_t time_fudge; /* For working around buggy init scripts */ 343 int ext_attr_ver; 344 profile_t profile; 345 int blocks_per_page; 346 347 /* 348 * For the use of callers of the e2fsck functions; not used by 349 * e2fsck functions themselves. 350 */ 351 void *priv_data; 352 }; 353 354 /* Used by the region allocation code */ 355 typedef __u32 region_addr_t; 356 typedef struct region_struct *region_t; 357 358 #ifndef HAVE_STRNLEN 359 #define strnlen(str, x) e2fsck_strnlen((str),(x)) 360 extern int e2fsck_strnlen(const char * s, int count); 361 #endif 362 363 /* 364 * Procedure declarations 365 */ 366 367 extern void e2fsck_pass1(e2fsck_t ctx); 368 extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf); 369 extern void e2fsck_pass2(e2fsck_t ctx); 370 extern void e2fsck_pass3(e2fsck_t ctx); 371 extern void e2fsck_pass4(e2fsck_t ctx); 372 extern void e2fsck_pass5(e2fsck_t ctx); 373 374 /* e2fsck.c */ 375 extern errcode_t e2fsck_allocate_context(e2fsck_t *ret); 376 extern errcode_t e2fsck_reset_context(e2fsck_t ctx); 377 extern void e2fsck_free_context(e2fsck_t ctx); 378 extern int e2fsck_run(e2fsck_t ctx); 379 380 381 /* badblock.c */ 382 extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file, 383 int replace_bad_blocks); 384 385 /* crc32.c */ 386 extern __u32 crc32_be(__u32 crc, unsigned char const *p, size_t len); 387 388 /* dirinfo.c */ 389 extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent); 390 extern void e2fsck_free_dir_info(e2fsck_t ctx); 391 extern int e2fsck_get_num_dirinfo(e2fsck_t ctx); 392 extern struct dir_info_iter *e2fsck_dir_info_iter_begin(e2fsck_t ctx); 393 extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx, 394 struct dir_info_iter *); 395 extern void e2fsck_dir_info_iter_end(e2fsck_t ctx, struct dir_info_iter *); 396 extern int e2fsck_dir_info_set_parent(e2fsck_t ctx, ext2_ino_t ino, 397 ext2_ino_t parent); 398 extern int e2fsck_dir_info_set_dotdot(e2fsck_t ctx, ext2_ino_t ino, 399 ext2_ino_t dotdot); 400 extern int e2fsck_dir_info_get_parent(e2fsck_t ctx, ext2_ino_t ino, 401 ext2_ino_t *parent); 402 extern int e2fsck_dir_info_get_dotdot(e2fsck_t ctx, ext2_ino_t ino, 403 ext2_ino_t *dotdot); 404 405 /* dx_dirinfo.c */ 406 extern void e2fsck_add_dx_dir(e2fsck_t ctx, ext2_ino_t ino, int num_blocks); 407 extern struct dx_dir_info *e2fsck_get_dx_dir_info(e2fsck_t ctx, ext2_ino_t ino); 408 extern void e2fsck_free_dx_dir_info(e2fsck_t ctx); 409 extern int e2fsck_get_num_dx_dirinfo(e2fsck_t ctx); 410 extern struct dx_dir_info *e2fsck_dx_dir_info_iter(e2fsck_t ctx, int *control); 411 412 /* ea_refcount.c */ 413 extern errcode_t ea_refcount_create(int size, ext2_refcount_t *ret); 414 extern void ea_refcount_free(ext2_refcount_t refcount); 415 extern errcode_t ea_refcount_fetch(ext2_refcount_t refcount, blk_t blk, 416 int *ret); 417 extern errcode_t ea_refcount_increment(ext2_refcount_t refcount, 418 blk_t blk, int *ret); 419 extern errcode_t ea_refcount_decrement(ext2_refcount_t refcount, 420 blk_t blk, int *ret); 421 extern errcode_t ea_refcount_store(ext2_refcount_t refcount, 422 blk_t blk, int count); 423 extern blk_t ext2fs_get_refcount_size(ext2_refcount_t refcount); 424 extern void ea_refcount_intr_begin(ext2_refcount_t refcount); 425 extern blk_t ea_refcount_intr_next(ext2_refcount_t refcount, int *ret); 426 427 /* ehandler.c */ 428 extern const char *ehandler_operation(const char *op); 429 extern void ehandler_init(io_channel channel); 430 431 /* journal.c */ 432 extern int e2fsck_check_ext3_journal(e2fsck_t ctx); 433 extern int e2fsck_run_ext3_journal(e2fsck_t ctx); 434 extern void e2fsck_move_ext3_journal(e2fsck_t ctx); 435 extern int e2fsck_fix_ext3_journal_hint(e2fsck_t ctx); 436 437 /* pass1.c */ 438 extern void e2fsck_setup_tdb_icount(e2fsck_t ctx, int flags, 439 ext2_icount_t *ret); 440 extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int bool); 441 extern int e2fsck_pass1_check_device_inode(ext2_filsys fs, 442 struct ext2_inode *inode); 443 extern int e2fsck_pass1_check_symlink(ext2_filsys fs, ext2_ino_t ino, 444 struct ext2_inode *inode, char *buf); 445 extern void e2fsck_clear_inode(e2fsck_t ctx, ext2_ino_t ino, 446 struct ext2_inode *inode, int restart_flag, 447 const char *source); 448 449 /* pass2.c */ 450 extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir, 451 ext2_ino_t ino, char *buf); 452 453 /* pass3.c */ 454 extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode); 455 extern errcode_t e2fsck_expand_directory(e2fsck_t ctx, ext2_ino_t dir, 456 int num, int gauranteed_size); 457 extern ext2_ino_t e2fsck_get_lost_and_found(e2fsck_t ctx, int fix); 458 extern errcode_t e2fsck_adjust_inode_count(e2fsck_t ctx, ext2_ino_t ino, 459 int adj); 460 461 462 /* region.c */ 463 extern region_t region_create(region_addr_t min, region_addr_t max); 464 extern void region_free(region_t region); 465 extern int region_allocate(region_t region, region_addr_t start, int n); 466 467 /* rehash.c */ 468 errcode_t e2fsck_rehash_dir(e2fsck_t ctx, ext2_ino_t ino); 469 void e2fsck_rehash_directories(e2fsck_t ctx); 470 471 /* super.c */ 472 void check_super_block(e2fsck_t ctx); 473 int check_backup_super_block(e2fsck_t ctx); 474 void check_resize_inode(e2fsck_t ctx); 475 476 /* util.c */ 477 extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size, 478 const char *description); 479 extern int ask(e2fsck_t ctx, const char * string, int def); 480 extern int ask_yn(const char * string, int def); 481 extern void fatal_error(e2fsck_t ctx, const char * fmt_string); 482 extern void e2fsck_read_bitmaps(e2fsck_t ctx); 483 extern void e2fsck_write_bitmaps(e2fsck_t ctx); 484 extern void preenhalt(e2fsck_t ctx); 485 extern char *string_copy(e2fsck_t ctx, const char *str, int len); 486 extern errcode_t e2fsck_zero_blocks(ext2_filsys fs, blk_t blk, int num, 487 blk_t *ret_blk, int *ret_count); 488 extern int fs_proc_check(const char *fs_name); 489 extern int check_for_modules(const char *fs_name); 490 #ifdef RESOURCE_TRACK 491 extern void print_resource_track(e2fsck_t ctx, 492 const char *desc, 493 struct resource_track *track, 494 io_channel channel); 495 extern void init_resource_track(struct resource_track *track, 496 io_channel channel); 497 #else 498 #define print_resource_track(ctx, desc, track, channel) do { } while (0) 499 #define init_resource_track(track, channel) do { } while (0) 500 #endif 501 extern int inode_has_valid_blocks(struct ext2_inode *inode); 502 extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino, 503 struct ext2_inode * inode, const char * proc); 504 extern void e2fsck_read_inode_full(e2fsck_t ctx, unsigned long ino, 505 struct ext2_inode *inode, 506 const int bufsize, const char *proc); 507 extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino, 508 struct ext2_inode * inode, const char * proc); 509 extern void e2fsck_write_inode_full(e2fsck_t ctx, unsigned long ino, 510 struct ext2_inode * inode, int bufsize, 511 const char *proc); 512 #ifdef MTRACE 513 extern void mtrace_print(char *mesg); 514 #endif 515 extern blk_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs, 516 const char *name, io_manager manager); 517 extern int ext2_file_type(unsigned int mode); 518 extern int write_all(int fd, char *buf, size_t count); 519 520 /* unix.c */ 521 extern void e2fsck_clear_progbar(e2fsck_t ctx); 522 extern int e2fsck_simple_progress(e2fsck_t ctx, const char *label, 523 float percent, unsigned int dpynum); 524 #endif /* _E2FSCK_H */ 525