e2fsck/e2fsck.h

   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 #include <stdio.h>
  10 #include <string.h>
  11 #ifdef HAVE_UNISTD_H
  12 #include <unistd.h>
  13 #endif
  14 #include <stdlib.h>
  15 #include <time.h>
  16 #ifdef HAVE_SYS_TYPES_H
  17 #include <sys/types.h>
  18 #endif
  19 #ifdef HAVE_SYS_TIME_H
  20 #include <sys/time.h>
  21 #endif
  22 #ifdef HAVE_SETJMP_H
  23 #include <setjmp.h>
  24 #endif
  25
  26 #if EXT2_FLAT_INCLUDES
  27 #include "ext2_fs.h"
  28 #include "ext2fs.h"
  29 #else
  30 #include "ext2fs/ext2_fs.h"
  31 #include "ext2fs/ext2fs.h"
  32 #endif
  33
  34 #ifdef ENABLE_NLS
  35 #include <libintl.h>
  36 #include <locale.h>
  37 #define _(a) (gettext (a))
  38 #ifdef gettext_noop
  39 #define N_(a) gettext_noop (a)
  40 #else
  41 #define N_(a) (a)
  42 #endif
  43 /* FIXME */
  44 #define NLS_CAT_NAME "e2fsprogs"
  45 #define LOCALEDIR "/usr/share/locale"
  46 /* FIXME */
  47 #else
  48 #define _(a) (a)
  49 #define N_(a) a
  50 #endif
  51
  52 /*
  53  * Exit codes used by fsck-type programs
  54  */
  55 #define FSCK_OK          0      /* No errors */
  56 #define FSCK_NONDESTRUCT 1      /* File system errors corrected */
  57 #define FSCK_REBOOT      2      /* System should be rebooted */
  58 #define FSCK_UNCORRECTED 4      /* File system errors left uncorrected */
  59 #define FSCK_ERROR       8      /* Operational error */
  60 #define FSCK_USAGE       16     /* Usage or syntax error */
  61 #define FSCK_CANCELED    32     /* Aborted with a signal or ^C */
  62 #define FSCK_LIBRARY     128    /* Shared library error */
  63
  64 /*
  65  * The last ext2fs revision level that this version of e2fsck is able to
  66  * support
  67  */
  68 #define E2FSCK_CURRENT_REV      1
  69
  70 /*
  71  * The directory information structure; stores directory information
  72  * collected in earlier passes, to avoid disk i/o in fetching the
  73  * directory information.
  74  */
  75 struct dir_info {
  76         ext2_ino_t              ino;    /* Inode number */
  77         ext2_ino_t              dotdot; /* Parent according to '..' */
  78         ext2_ino_t              parent; /* Parent according to treewalk */
  79 };
  80
  81
  82 /*
  83  * The indexed directory information structure; stores information for
  84  * directories which contain a hash tree index.
  85  */
  86 struct dx_dir_info {
  87         ext2_ino_t              ino;            /* Inode number */
  88         int                     numblocks;      /* number of blocks */
  89         int                     hashversion;
  90         short                   depth;          /* depth of tree */
  91         struct dx_dirblock_info *dx_block;      /* Array of size numblocks */
  92 };
  93
  94 #define DX_DIRBLOCK_ROOT        1
  95 #define DX_DIRBLOCK_LEAF        2
  96 #define DX_DIRBLOCK_NODE        3
  97 #define DX_DIRBLOCK_CORRUPT     4
  98 #define DX_DIRBLOCK_CLEARED     8
  99
 100 struct dx_dirblock_info {
 101         int             type;
 102         blk_t           phys;
 103         int             flags;
 104         blk_t           parent;
 105         ext2_dirhash_t  min_hash;
 106         ext2_dirhash_t  max_hash;
 107         ext2_dirhash_t  node_min_hash;
 108         ext2_dirhash_t  node_max_hash;
 109 };
 110
 111 #define DX_FLAG_REFERENCED      1
 112 #define DX_FLAG_DUP_REF         2
 113 #define DX_FLAG_FIRST           4
 114 #define DX_FLAG_LAST            8
 115
 116 #ifdef RESOURCE_TRACK
 117 /*
 118  * This structure is used for keeping track of how much resources have
 119  * been used for a particular pass of e2fsck.
 120  */
 121 struct resource_track {
 122         struct timeval time_start;
 123         struct timeval user_start;
 124         struct timeval system_start;
 125         void    *brk_start;
 126 };
 127 #endif
 128
 129 /*
 130  * E2fsck options
 131  */
 132 #define E2F_OPT_READONLY        0x0001
 133 #define E2F_OPT_PREEN           0x0002
 134 #define E2F_OPT_YES             0x0004
 135 #define E2F_OPT_NO              0x0008
 136 #define E2F_OPT_TIME            0x0010
 137 #define E2F_OPT_TIME2           0x0020
 138 #define E2F_OPT_CHECKBLOCKS     0x0040
 139 #define E2F_OPT_DEBUG           0x0080
 140 #define E2F_OPT_FORCE           0x0100
 141 #define E2F_OPT_WRITECHECK      0x0200
 142 #define E2F_OPT_COMPRESS_DIRS   0x0400
 143
 144 /*
 145  * E2fsck flags
 146  */
 147 #define E2F_FLAG_ABORT          0x0001 /* Abort signaled */
 148 #define E2F_FLAG_CANCEL         0x0002 /* Cancel signaled */
 149 #define E2F_FLAG_SIGNAL_MASK    0x0003
 150 #define E2F_FLAG_RESTART        0x0004 /* Restart signaled */
 151
 152 #define E2F_FLAG_SETJMP_OK      0x0010 /* Setjmp valid for abort */
 153
 154 #define E2F_FLAG_PROG_BAR       0x0020 /* Progress bar on screen */
 155 #define E2F_FLAG_PROG_SUPPRESS  0x0040 /* Progress suspended */
 156 #define E2F_FLAG_JOURNAL_INODE  0x0080 /* Create a new ext3 journal inode */
 157 #define E2F_FLAG_SB_SPECIFIED   0x0100 /* The superblock was explicitly
 158                                         * specified by the user */
 159
 160 /*
 161  * Defines for indicating the e2fsck pass number
 162  */
 163 #define E2F_PASS_1      1
 164 #define E2F_PASS_2      2
 165 #define E2F_PASS_3      3
 166 #define E2F_PASS_4      4
 167 #define E2F_PASS_5      5
 168 #define E2F_PASS_1B     6
 169
 170 /*
 171  * Define the extended attribute refcount structure
 172  */
 173 typedef struct ea_refcount *ext2_refcount_t;
 174
 175 /*
 176  * This is the global e2fsck structure.
 177  */
 178 typedef struct e2fsck_struct *e2fsck_t;
 179
 180 struct e2fsck_struct {
 181         ext2_filsys fs;
 182         const char *program_name;
 183         const char *filesystem_name;
 184         const char *device_name;
 185         int     flags;          /* E2fsck internal flags */
 186         int     options;
 187         blk_t   use_superblock; /* sb requested by user */
 188         blk_t   superblock;     /* sb used to open fs */
 189         int     blocksize;      /* blocksize */
 190         blk_t   num_blocks;     /* Total number of blocks */
 191
 192 #ifdef HAVE_SETJMP_H
 193         jmp_buf abort_loc;
 194 #endif
 195         unsigned long abort_code;
 196
 197         int (*progress)(e2fsck_t ctx, int pass, unsigned long cur,
 198                         unsigned long max);
 199
 200         ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */
 201         ext2fs_inode_bitmap inode_bad_map; /* Inodes which are bad somehow */
 202         ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */
 203         ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */
 204         ext2fs_inode_bitmap inode_imagic_map; /* AFS inodes */
 205         ext2fs_inode_bitmap inode_reg_map; /* Inodes which are regular files*/
 206
 207         ext2fs_block_bitmap block_found_map; /* Blocks which are in use */
 208         ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */
 209         ext2fs_block_bitmap block_ea_map; /* Blocks which are used by EA's */
 210
 211         /*
 212          * Inode count arrays
 213          */
 214         ext2_icount_t   inode_count;
 215         ext2_icount_t inode_link_info;
 216
 217         ext2_refcount_t refcount;
 218         ext2_refcount_t refcount_extra;
 219
 220         /*
 221          * Array of flags indicating whether an inode bitmap, block
 222          * bitmap, or inode table is invalid
 223          */
 224         int *invalid_inode_bitmap_flag;
 225         int *invalid_block_bitmap_flag;
 226         int *invalid_inode_table_flag;
 227         int invalid_bitmaps;    /* There are invalid bitmaps/itable */
 228
 229         /*
 230          * Block buffer
 231          */
 232         char *block_buf;
 233
 234         /*
 235          * For pass1_check_directory and pass1_get_blocks
 236          */
 237         ext2_ino_t stashed_ino;
 238         struct ext2_inode *stashed_inode;
 239
 240         /*
 241          * Location of the lost and found directory
 242          */
 243         ext2_ino_t lost_and_found;
 244         int bad_lost_and_found;
 245
 246         /*
 247          * Directory information
 248          */
 249         int             dir_info_count;
 250         int             dir_info_size;
 251         struct dir_info *dir_info;
 252
 253         /*
 254          * Indexed directory information
 255          */
 256         int             dx_dir_info_count;
 257         int             dx_dir_info_size;
 258         struct dx_dir_info *dx_dir_info;
 259
 260         /*
 261          * Directories to hash
 262          */
 263         ext2_u32_list   dirs_to_hash;
 264
 265         /*
 266          * Tuning parameters
 267          */
 268         int process_inode_size;
 269         int inode_buffer_blocks;
 270
 271         /*
 272          * ext3 journal support
 273          */
 274         io_channel      journal_io;
 275         const char      *journal_name;
 276
 277 #ifdef RESOURCE_TRACK
 278         /*
 279          * For timing purposes
 280          */
 281         struct resource_track   global_rtrack;
 282 #endif
 283
 284         /*
 285          * How we display the progress update (for unix)
 286          */
 287         int progress_fd;
 288         int progress_pos;
 289         int progress_last_percent;
 290         unsigned int progress_last_time;
 291
 292         /* File counts */
 293         int fs_directory_count;
 294         int fs_regular_count;
 295         int fs_blockdev_count;
 296         int fs_chardev_count;
 297         int fs_links_count;
 298         int fs_symlinks_count;
 299         int fs_fast_symlinks_count;
 300         int fs_fifo_count;
 301         int fs_total_count;
 302         int fs_badblocks_count;
 303         int fs_sockets_count;
 304         int fs_ind_count;
 305         int fs_dind_count;
 306         int fs_tind_count;
 307         int fs_fragmented;
 308         int large_files;
 309         int fs_ext_attr_inodes;
 310         int fs_ext_attr_blocks;
 311
 312         int ext_attr_ver;
 313
 314         /*
 315          * For the use of callers of the e2fsck functions; not used by
 316          * e2fsck functions themselves.
 317          */
 318         void *priv_data;
 319 };
 320
 321 /* Used by the region allocation code */
 322 typedef __u32 region_addr_t;
 323 typedef struct region_struct *region_t;
 324
 325 /*
 326  * Procedure declarations
 327  */
 328
 329 extern void e2fsck_pass1(e2fsck_t ctx);
 330 extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf);
 331 extern void e2fsck_pass2(e2fsck_t ctx);
 332 extern void e2fsck_pass3(e2fsck_t ctx);
 333 extern void e2fsck_pass4(e2fsck_t ctx);
 334 extern void e2fsck_pass5(e2fsck_t ctx);
 335
 336 /* e2fsck.c */
 337 extern errcode_t e2fsck_allocate_context(e2fsck_t *ret);
 338 extern errcode_t e2fsck_reset_context(e2fsck_t ctx);
 339 extern void e2fsck_free_context(e2fsck_t ctx);
 340 extern int e2fsck_run(e2fsck_t ctx);
 341
 342
 343 /* badblock.c */
 344 extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
 345                                  int replace_bad_blocks);
 346 extern void test_disk(e2fsck_t ctx);
 347
 348 /* dirinfo.c */
 349 extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent);
 350 extern struct dir_info *e2fsck_get_dir_info(e2fsck_t ctx, ext2_ino_t ino);
 351 extern void e2fsck_free_dir_info(e2fsck_t ctx);
 352 extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
 353 extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx, int *control);
 354
 355 /* dx_dirinfo.c */
 356 extern void e2fsck_add_dx_dir(e2fsck_t ctx, ext2_ino_t ino, int num_blocks);
 357 extern struct dx_dir_info *e2fsck_get_dx_dir_info(e2fsck_t ctx, ext2_ino_t ino);
 358 extern void e2fsck_free_dx_dir_info(e2fsck_t ctx);
 359 extern int e2fsck_get_num_dx_dirinfo(e2fsck_t ctx);
 360 extern struct dx_dir_info *e2fsck_dx_dir_info_iter(e2fsck_t ctx, int *control);
 361
 362 /* ea_refcount.c */
 363 extern errcode_t ea_refcount_create(int size, ext2_refcount_t *ret);
 364 extern void ea_refcount_free(ext2_refcount_t refcount);
 365 extern errcode_t ea_refcount_fetch(ext2_refcount_t refcount, blk_t blk,
 366                                    int *ret);
 367 extern errcode_t ea_refcount_increment(ext2_refcount_t refcount,
 368                                        blk_t blk, int *ret);
 369 extern errcode_t ea_refcount_decrement(ext2_refcount_t refcount,
 370                                        blk_t blk, int *ret);
 371 extern errcode_t ea_refcount_store(ext2_refcount_t refcount,
 372                                    blk_t blk, int count);
 373 extern blk_t ext2fs_get_refcount_size(ext2_refcount_t refcount);
 374 extern void ea_refcount_intr_begin(ext2_refcount_t refcount);
 375 extern blk_t ea_refcount_intr_next(ext2_refcount_t refcount, int *ret);
 376
 377 /* ehandler.c */
 378 extern const char *ehandler_operation(const char *op);
 379 extern void ehandler_init(io_channel channel);
 380
 381 /* journal.c */
 382 extern int e2fsck_check_ext3_journal(e2fsck_t ctx);
 383 extern int e2fsck_run_ext3_journal(e2fsck_t ctx);
 384 extern void e2fsck_move_ext3_journal(e2fsck_t ctx);
 385
 386 /* pass1.c */
 387 extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int bool);
 388 extern int e2fsck_pass1_check_device_inode(ext2_filsys fs,
 389                                            struct ext2_inode *inode);
 390 extern int e2fsck_pass1_check_symlink(ext2_filsys fs,
 391                                       struct ext2_inode *inode, char *buf);
 392
 393 /* pass2.c */
 394 extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir,
 395                                     ext2_ino_t ino, char *buf);
 396
 397 /* pass3.c */
 398 extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode);
 399 extern errcode_t e2fsck_expand_directory(e2fsck_t ctx, ext2_ino_t dir,
 400                                          int num, int gauranteed_size);
 401 extern ext2_ino_t e2fsck_get_lost_and_found(e2fsck_t ctx, int fix);
 402
 403
 404 /* region.c */
 405 extern region_t region_create(region_addr_t min, region_addr_t max);
 406 extern void region_free(region_t region);
 407 extern int region_allocate(region_t region, region_addr_t start, int n);
 408
 409 /* rehash.c */
 410 errcode_t e2fsck_rehash_dir(e2fsck_t ctx, ext2_ino_t ino);
 411 void e2fsck_rehash_directories(e2fsck_t ctx);
 412
 413 /* super.c */
 414 void check_super_block(e2fsck_t ctx);
 415 errcode_t e2fsck_get_device_size(e2fsck_t ctx);
 416
 417 /* swapfs.c */
 418 void swap_filesys(e2fsck_t ctx);
 419
 420 /* util.c */
 421 extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
 422                                     const char *description);
 423 extern int ask(e2fsck_t ctx, const char * string, int def);
 424 extern int ask_yn(const char * string, int def);
 425 extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
 426 extern void e2fsck_read_bitmaps(e2fsck_t ctx);
 427 extern void e2fsck_write_bitmaps(e2fsck_t ctx);
 428 extern void preenhalt(e2fsck_t ctx);
 429 #ifdef RESOURCE_TRACK
 430 extern void print_resource_track(const char *desc,
 431                                  struct resource_track *track);
 432 extern void init_resource_track(struct resource_track *track);
 433 #endif
 434 extern int inode_has_valid_blocks(struct ext2_inode *inode);
 435 extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
 436                               struct ext2_inode * inode, const char * proc);
 437 extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
 438                                struct ext2_inode * inode, const char * proc);
 439 #ifdef MTRACE
 440 extern void mtrace_print(char *mesg);
 441 #endif
 442 extern blk_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs,
 443                            const char *name, io_manager manager);
 444 extern int ext2_file_type(unsigned int mode);
 445
 446 /* unix.c */
 447 extern void e2fsck_clear_progbar(e2fsck_t ctx);