e2fsck.h revision d0ff90d5202428583c78a60c3042e7b60d88bc45
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 */ 87struct 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 */ 98struct 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 112struct 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 */ 133struct resource_track { 134 struct timeval time_start; 135 struct timeval user_start; 136 struct timeval system_start; 137 void *brk_start; 138}; 139#endif 140 141/* 142 * E2fsck options 143 */ 144#define E2F_OPT_READONLY 0x0001 145#define E2F_OPT_PREEN 0x0002 146#define E2F_OPT_YES 0x0004 147#define E2F_OPT_NO 0x0008 148#define E2F_OPT_TIME 0x0010 149#define E2F_OPT_TIME2 0x0020 150#define E2F_OPT_CHECKBLOCKS 0x0040 151#define E2F_OPT_DEBUG 0x0080 152#define E2F_OPT_FORCE 0x0100 153#define E2F_OPT_WRITECHECK 0x0200 154#define E2F_OPT_COMPRESS_DIRS 0x0400 155 156/* 157 * E2fsck flags 158 */ 159#define E2F_FLAG_ABORT 0x0001 /* Abort signaled */ 160#define E2F_FLAG_CANCEL 0x0002 /* Cancel signaled */ 161#define E2F_FLAG_SIGNAL_MASK 0x0003 162#define E2F_FLAG_RESTART 0x0004 /* Restart signaled */ 163 164#define E2F_FLAG_SETJMP_OK 0x0010 /* Setjmp valid for abort */ 165 166#define E2F_FLAG_PROG_BAR 0x0020 /* Progress bar on screen */ 167#define E2F_FLAG_PROG_SUPPRESS 0x0040 /* Progress suspended */ 168#define E2F_FLAG_JOURNAL_INODE 0x0080 /* Create a new ext3 journal inode */ 169#define E2F_FLAG_SB_SPECIFIED 0x0100 /* The superblock was explicitly 170 * specified by the user */ 171#define E2F_FLAG_RESTARTED 0x0200 /* E2fsck has been restarted */ 172#define E2F_FLAG_RESIZE_INODE 0x0400 /* Request to recreate resize inode */ 173 174/* 175 * Defines for indicating the e2fsck pass number 176 */ 177#define E2F_PASS_1 1 178#define E2F_PASS_2 2 179#define E2F_PASS_3 3 180#define E2F_PASS_4 4 181#define E2F_PASS_5 5 182#define E2F_PASS_1B 6 183 184/* 185 * Define the extended attribute refcount structure 186 */ 187typedef struct ea_refcount *ext2_refcount_t; 188 189/* 190 * This is the global e2fsck structure. 191 */ 192typedef struct e2fsck_struct *e2fsck_t; 193 194struct e2fsck_struct { 195 ext2_filsys fs; 196 const char *program_name; 197 char *filesystem_name; 198 char *device_name; 199 char *io_options; 200 int flags; /* E2fsck internal flags */ 201 int options; 202 blk_t use_superblock; /* sb requested by user */ 203 blk_t superblock; /* sb used to open fs */ 204 int blocksize; /* blocksize */ 205 blk_t num_blocks; /* Total number of blocks */ 206 int mount_flags; 207 blkid_cache blkid; /* blkid cache */ 208 209#ifdef HAVE_SETJMP_H 210 jmp_buf abort_loc; 211#endif 212 unsigned long abort_code; 213 214 int (*progress)(e2fsck_t ctx, int pass, unsigned long cur, 215 unsigned long max); 216 217 ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */ 218 ext2fs_inode_bitmap inode_bad_map; /* Inodes which are bad somehow */ 219 ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */ 220 ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */ 221 ext2fs_inode_bitmap inode_imagic_map; /* AFS inodes */ 222 ext2fs_inode_bitmap inode_reg_map; /* Inodes which are regular files*/ 223 224 ext2fs_block_bitmap block_found_map; /* Blocks which are in use */ 225 ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */ 226 ext2fs_block_bitmap block_ea_map; /* Blocks which are used by EA's */ 227 228 /* 229 * Inode count arrays 230 */ 231 ext2_icount_t inode_count; 232 ext2_icount_t inode_link_info; 233 234 ext2_refcount_t refcount; 235 ext2_refcount_t refcount_extra; 236 237 /* 238 * Array of flags indicating whether an inode bitmap, block 239 * bitmap, or inode table is invalid 240 */ 241 int *invalid_inode_bitmap_flag; 242 int *invalid_block_bitmap_flag; 243 int *invalid_inode_table_flag; 244 int invalid_bitmaps; /* There are invalid bitmaps/itable */ 245 246 /* 247 * Block buffer 248 */ 249 char *block_buf; 250 251 /* 252 * For pass1_check_directory and pass1_get_blocks 253 */ 254 ext2_ino_t stashed_ino; 255 struct ext2_inode *stashed_inode; 256 257 /* 258 * Location of the lost and found directory 259 */ 260 ext2_ino_t lost_and_found; 261 int bad_lost_and_found; 262 263 /* 264 * Directory information 265 */ 266 int dir_info_count; 267 int dir_info_size; 268 struct dir_info *dir_info; 269 270 /* 271 * Indexed directory information 272 */ 273 int dx_dir_info_count; 274 int dx_dir_info_size; 275 struct dx_dir_info *dx_dir_info; 276 277 /* 278 * Directories to hash 279 */ 280 ext2_u32_list dirs_to_hash; 281 282 /* 283 * Tuning parameters 284 */ 285 int process_inode_size; 286 int inode_buffer_blocks; 287 288 /* 289 * ext3 journal support 290 */ 291 io_channel journal_io; 292 char *journal_name; 293 294#ifdef RESOURCE_TRACK 295 /* 296 * For timing purposes 297 */ 298 struct resource_track global_rtrack; 299#endif 300 301 /* 302 * How we display the progress update (for unix) 303 */ 304 int progress_fd; 305 int progress_pos; 306 int progress_last_percent; 307 unsigned int progress_last_time; 308 int interactive; /* Are we connected directly to a tty? */ 309 char start_meta[2], stop_meta[2]; 310 311 /* File counts */ 312 __u32 fs_directory_count; 313 __u32 fs_regular_count; 314 __u32 fs_blockdev_count; 315 __u32 fs_chardev_count; 316 __u32 fs_links_count; 317 __u32 fs_symlinks_count; 318 __u32 fs_fast_symlinks_count; 319 __u32 fs_fifo_count; 320 __u32 fs_total_count; 321 __u32 fs_badblocks_count; 322 __u32 fs_sockets_count; 323 __u32 fs_ind_count; 324 __u32 fs_dind_count; 325 __u32 fs_tind_count; 326 __u32 fs_fragmented; 327 __u32 large_files; 328 __u32 fs_ext_attr_inodes; 329 __u32 fs_ext_attr_blocks; 330 331 time_t now; 332 333 int ext_attr_ver; 334 335 profile_t profile; 336 337 /* 338 * For the use of callers of the e2fsck functions; not used by 339 * e2fsck functions themselves. 340 */ 341 void *priv_data; 342}; 343 344/* Used by the region allocation code */ 345typedef __u32 region_addr_t; 346typedef struct region_struct *region_t; 347 348#ifndef HAVE_STRNLEN 349#define strnlen(str, x) e2fsck_strnlen((str),(x)) 350extern int e2fsck_strnlen(const char * s, int count); 351#endif 352 353/* 354 * Procedure declarations 355 */ 356 357extern void e2fsck_pass1(e2fsck_t ctx); 358extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf); 359extern void e2fsck_pass2(e2fsck_t ctx); 360extern void e2fsck_pass3(e2fsck_t ctx); 361extern void e2fsck_pass4(e2fsck_t ctx); 362extern void e2fsck_pass5(e2fsck_t ctx); 363 364/* e2fsck.c */ 365extern errcode_t e2fsck_allocate_context(e2fsck_t *ret); 366extern errcode_t e2fsck_reset_context(e2fsck_t ctx); 367extern void e2fsck_free_context(e2fsck_t ctx); 368extern int e2fsck_run(e2fsck_t ctx); 369 370 371/* badblock.c */ 372extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file, 373 int replace_bad_blocks); 374 375/* dirinfo.c */ 376extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent); 377extern struct dir_info *e2fsck_get_dir_info(e2fsck_t ctx, ext2_ino_t ino); 378extern void e2fsck_free_dir_info(e2fsck_t ctx); 379extern int e2fsck_get_num_dirinfo(e2fsck_t ctx); 380extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx, int *control); 381 382/* dx_dirinfo.c */ 383extern void e2fsck_add_dx_dir(e2fsck_t ctx, ext2_ino_t ino, int num_blocks); 384extern struct dx_dir_info *e2fsck_get_dx_dir_info(e2fsck_t ctx, ext2_ino_t ino); 385extern void e2fsck_free_dx_dir_info(e2fsck_t ctx); 386extern int e2fsck_get_num_dx_dirinfo(e2fsck_t ctx); 387extern struct dx_dir_info *e2fsck_dx_dir_info_iter(e2fsck_t ctx, int *control); 388 389/* ea_refcount.c */ 390extern errcode_t ea_refcount_create(int size, ext2_refcount_t *ret); 391extern void ea_refcount_free(ext2_refcount_t refcount); 392extern errcode_t ea_refcount_fetch(ext2_refcount_t refcount, blk_t blk, 393 int *ret); 394extern errcode_t ea_refcount_increment(ext2_refcount_t refcount, 395 blk_t blk, int *ret); 396extern errcode_t ea_refcount_decrement(ext2_refcount_t refcount, 397 blk_t blk, int *ret); 398extern errcode_t ea_refcount_store(ext2_refcount_t refcount, 399 blk_t blk, int count); 400extern blk_t ext2fs_get_refcount_size(ext2_refcount_t refcount); 401extern void ea_refcount_intr_begin(ext2_refcount_t refcount); 402extern blk_t ea_refcount_intr_next(ext2_refcount_t refcount, int *ret); 403 404/* ehandler.c */ 405extern const char *ehandler_operation(const char *op); 406extern void ehandler_init(io_channel channel); 407 408/* journal.c */ 409extern int e2fsck_check_ext3_journal(e2fsck_t ctx); 410extern int e2fsck_run_ext3_journal(e2fsck_t ctx); 411extern void e2fsck_move_ext3_journal(e2fsck_t ctx); 412extern int e2fsck_fix_ext3_journal_hint(e2fsck_t ctx); 413 414/* pass1.c */ 415extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int bool); 416extern int e2fsck_pass1_check_device_inode(ext2_filsys fs, 417 struct ext2_inode *inode); 418extern int e2fsck_pass1_check_symlink(ext2_filsys fs, 419 struct ext2_inode *inode, char *buf); 420 421/* pass2.c */ 422extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir, 423 ext2_ino_t ino, char *buf); 424 425/* pass3.c */ 426extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode); 427extern errcode_t e2fsck_expand_directory(e2fsck_t ctx, ext2_ino_t dir, 428 int num, int gauranteed_size); 429extern ext2_ino_t e2fsck_get_lost_and_found(e2fsck_t ctx, int fix); 430extern errcode_t e2fsck_adjust_inode_count(e2fsck_t ctx, ext2_ino_t ino, 431 int adj); 432 433 434/* region.c */ 435extern region_t region_create(region_addr_t min, region_addr_t max); 436extern void region_free(region_t region); 437extern int region_allocate(region_t region, region_addr_t start, int n); 438 439/* rehash.c */ 440errcode_t e2fsck_rehash_dir(e2fsck_t ctx, ext2_ino_t ino); 441void e2fsck_rehash_directories(e2fsck_t ctx); 442 443/* super.c */ 444void check_super_block(e2fsck_t ctx); 445errcode_t e2fsck_get_device_size(e2fsck_t ctx); 446 447/* swapfs.c */ 448void swap_filesys(e2fsck_t ctx); 449 450/* util.c */ 451extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size, 452 const char *description); 453extern int ask(e2fsck_t ctx, const char * string, int def); 454extern int ask_yn(const char * string, int def); 455extern void fatal_error(e2fsck_t ctx, const char * fmt_string); 456extern void e2fsck_read_bitmaps(e2fsck_t ctx); 457extern void e2fsck_write_bitmaps(e2fsck_t ctx); 458extern void preenhalt(e2fsck_t ctx); 459extern char *string_copy(e2fsck_t ctx, const char *str, int len); 460#ifdef RESOURCE_TRACK 461extern void print_resource_track(const char *desc, 462 struct resource_track *track); 463extern void init_resource_track(struct resource_track *track); 464#endif 465extern int inode_has_valid_blocks(struct ext2_inode *inode); 466extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino, 467 struct ext2_inode * inode, const char * proc); 468extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino, 469 struct ext2_inode * inode, const char * proc); 470extern void e2fsck_write_inode_full(e2fsck_t ctx, unsigned long ino, 471 struct ext2_inode * inode, int bufsize, 472 const char *proc); 473#ifdef MTRACE 474extern void mtrace_print(char *mesg); 475#endif 476extern blk_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs, 477 const char *name, io_manager manager); 478extern int ext2_file_type(unsigned int mode); 479 480/* unix.c */ 481extern void e2fsck_clear_progbar(e2fsck_t ctx); 482extern int e2fsck_simple_progress(e2fsck_t ctx, const char *label, 483 float percent, unsigned int dpynum); 484#endif /* _E2FSCK_H */ 485