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 #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 #include "quota/mkquota.h"
  65
  66 /*
  67  * Exit codes used by fsck-type programs
  68  */
  69 #define FSCK_OK          0      /* No errors */
  70 #define FSCK_NONDESTRUCT 1      /* File system errors corrected */
  71 #define FSCK_REBOOT      2      /* System should be rebooted */
  72 #define FSCK_UNCORRECTED 4      /* File system errors left uncorrected */
  73 #define FSCK_ERROR       8      /* Operational error */
  74 #define FSCK_USAGE       16     /* Usage or syntax error */
  75 #define FSCK_CANCELED    32     /* Aborted with a signal or ^C */
  76 #define FSCK_LIBRARY     128    /* Shared library error */
  77
  78 /*
  79  * The last ext2fs revision level that this version of e2fsck is able to
  80  * support
  81  */
  82 #define E2FSCK_CURRENT_REV      1
  83
  84 /*
  85  * The directory information structure; stores directory information
  86  * collected in earlier passes, to avoid disk i/o in fetching the
  87  * directory information.
  88  */
  89 struct dir_info {
  90         ext2_ino_t              ino;    /* Inode number */
  91         ext2_ino_t              dotdot; /* Parent according to '..' */
  92         ext2_ino_t              parent; /* Parent according to treewalk */
  93 };
  94
  95
  96 /*
  97  * The indexed directory information structure; stores information for
  98  * directories which contain a hash tree index.
  99  */
 100 struct dx_dir_info {
 101         ext2_ino_t              ino;            /* Inode number */
 102         int                     numblocks;      /* number of blocks */
 103         int                     hashversion;
 104         short                   depth;          /* depth of tree */
 105         struct dx_dirblock_info *dx_block;      /* Array of size numblocks */
 106 };
 107
 108 #define DX_DIRBLOCK_ROOT        1
 109 #define DX_DIRBLOCK_LEAF        2
 110 #define DX_DIRBLOCK_NODE        3
 111 #define DX_DIRBLOCK_CORRUPT     4
 112 #define DX_DIRBLOCK_CLEARED     8
 113
 114 struct dx_dirblock_info {
 115         int             type;
 116         blk_t           phys;
 117         int             flags;
 118         blk_t           parent;
 119         ext2_dirhash_t  min_hash;
 120         ext2_dirhash_t  max_hash;
 121         ext2_dirhash_t  node_min_hash;
 122         ext2_dirhash_t  node_max_hash;
 123 };
 124
 125 #define DX_FLAG_REFERENCED      1
 126 #define DX_FLAG_DUP_REF         2
 127 #define DX_FLAG_FIRST           4
 128 #define DX_FLAG_LAST            8
 129
 130 #define RESOURCE_TRACK
 131
 132 #ifdef RESOURCE_TRACK
 133 /*
 134  * This structure is used for keeping track of how much resources have
 135  * been used for a particular pass of e2fsck.
 136  */
 137 struct resource_track {
 138         struct timeval time_start;
 139         struct timeval user_start;
 140         struct timeval system_start;
 141         void    *brk_start;
 142         unsigned long long bytes_read;
 143         unsigned long long bytes_written;
 144 };
 145 #endif
 146
 147 /*
 148  * E2fsck options
 149  */
 150 #define E2F_OPT_READONLY        0x0001
 151 #define E2F_OPT_PREEN           0x0002
 152 #define E2F_OPT_YES             0x0004
 153 #define E2F_OPT_NO              0x0008
 154 #define E2F_OPT_TIME            0x0010
 155 #define E2F_OPT_TIME2           0x0020
 156 #define E2F_OPT_CHECKBLOCKS     0x0040
 157 #define E2F_OPT_DEBUG           0x0080
 158 #define E2F_OPT_FORCE           0x0100
 159 #define E2F_OPT_WRITECHECK      0x0200
 160 #define E2F_OPT_COMPRESS_DIRS   0x0400
 161 #define E2F_OPT_FRAGCHECK       0x0800
 162 #define E2F_OPT_JOURNAL_ONLY    0x1000 /* only replay the journal */
 163 #define E2F_OPT_DISCARD         0x2000
 164
 165 /*
 166  * E2fsck flags
 167  */
 168 #define E2F_FLAG_ABORT          0x0001 /* Abort signaled */
 169 #define E2F_FLAG_CANCEL         0x0002 /* Cancel signaled */
 170 #define E2F_FLAG_SIGNAL_MASK    0x0003
 171 #define E2F_FLAG_RESTART        0x0004 /* Restart signaled */
 172 #define E2F_FLAG_RESTART_LATER  0x0008 /* Restart after all iterations done */
 173
 174 #define E2F_FLAG_SETJMP_OK      0x0010 /* Setjmp valid for abort */
 175
 176 #define E2F_FLAG_PROG_BAR       0x0020 /* Progress bar on screen */
 177 #define E2F_FLAG_PROG_SUPPRESS  0x0040 /* Progress suspended */
 178 #define E2F_FLAG_JOURNAL_INODE  0x0080 /* Create a new ext3 journal inode */
 179 #define E2F_FLAG_SB_SPECIFIED   0x0100 /* The superblock was explicitly
 180                                         * specified by the user */
 181 #define E2F_FLAG_RESTARTED      0x0200 /* E2fsck has been restarted */
 182 #define E2F_FLAG_RESIZE_INODE   0x0400 /* Request to recreate resize inode */
 183 #define E2F_FLAG_GOT_DEVSIZE    0x0800 /* Device size has been fetched */
 184 #define E2F_FLAG_EXITING        0x1000 /* E2fsck exiting due to errors */
 185 #define E2F_FLAG_TIME_INSANE    0x2000 /* Time is insane */
 186
 187 #define E2F_RESET_FLAGS (E2F_FLAG_TIME_INSANE)
 188
 189 /*
 190  * Defines for indicating the e2fsck pass number
 191  */
 192 #define E2F_PASS_1      1
 193 #define E2F_PASS_2      2
 194 #define E2F_PASS_3      3
 195 #define E2F_PASS_4      4
 196 #define E2F_PASS_5      5
 197 #define E2F_PASS_1B     6
 198
 199 /*
 200  * Define the extended attribute refcount structure
 201  */
 202 typedef struct ea_refcount *ext2_refcount_t;
 203
 204 /*
 205  * This is the global e2fsck structure.
 206  */
 207 typedef struct e2fsck_struct *e2fsck_t;
 208
 209 #define MAX_EXTENT_DEPTH_COUNT 5
 210
 211 struct e2fsck_struct {
 212         ext2_filsys fs;
 213         const char *program_name;
 214         char *filesystem_name;
 215         char *device_name;
 216         char *io_options;
 217         int     flags;          /* E2fsck internal flags */
 218         int     options;
 219         int     blocksize;      /* blocksize */
 220         blk64_t use_superblock; /* sb requested by user */
 221         blk64_t superblock;     /* sb used to open fs */
 222         blk64_t num_blocks;     /* Total number of blocks */
 223         blk64_t free_blocks;
 224         ino_t   free_inodes;
 225         int     mount_flags;
 226         blkid_cache blkid;      /* blkid cache */
 227
 228 #ifdef HAVE_SETJMP_H
 229         jmp_buf abort_loc;
 230 #endif
 231         unsigned long abort_code;
 232
 233         int (*progress)(e2fsck_t ctx, int pass, unsigned long cur,
 234                         unsigned long max);
 235
 236         ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */
 237         ext2fs_inode_bitmap inode_bad_map; /* Inodes which are bad somehow */
 238         ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */
 239         ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */
 240         ext2fs_inode_bitmap inode_imagic_map; /* AFS inodes */
 241         ext2fs_inode_bitmap inode_reg_map; /* Inodes which are regular files*/
 242
 243         ext2fs_block_bitmap block_found_map; /* Blocks which are in use */
 244         ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */
 245         ext2fs_block_bitmap block_ea_map; /* Blocks which are used by EA's */
 246
 247         /*
 248          * Inode count arrays
 249          */
 250         ext2_icount_t   inode_count;
 251         ext2_icount_t inode_link_info;
 252
 253         ext2_refcount_t refcount;
 254         ext2_refcount_t refcount_extra;
 255
 256         /*
 257          * Array of flags indicating whether an inode bitmap, block
 258          * bitmap, or inode table is invalid
 259          */
 260         int *invalid_inode_bitmap_flag;
 261         int *invalid_block_bitmap_flag;
 262         int *invalid_inode_table_flag;
 263         int invalid_bitmaps;    /* There are invalid bitmaps/itable */
 264
 265         /*
 266          * Block buffer
 267          */
 268         char *block_buf;
 269
 270         /*
 271          * For pass1_check_directory and pass1_get_blocks
 272          */
 273         ext2_ino_t stashed_ino;
 274         struct ext2_inode *stashed_inode;
 275
 276         /*
 277          * Location of the lost and found directory
 278          */
 279         ext2_ino_t lost_and_found;
 280         int bad_lost_and_found;
 281
 282         /*
 283          * Directory information
 284          */
 285         struct dir_info_db      *dir_info;
 286
 287         /*
 288          * Indexed directory information
 289          */
 290         int             dx_dir_info_count;
 291         int             dx_dir_info_size;
 292         struct dx_dir_info *dx_dir_info;
 293
 294         /*
 295          * Directories to hash
 296          */
 297         ext2_u32_list   dirs_to_hash;
 298
 299         /*
 300          * Tuning parameters
 301          */
 302         int process_inode_size;
 303         int inode_buffer_blocks;
 304         unsigned int htree_slack_percentage;
 305
 306         /*
 307          * ext3 journal support
 308          */
 309         io_channel      journal_io;
 310         char    *journal_name;
 311
 312         /*
 313          * Ext4 quota support
 314          */
 315         quota_ctx_t qctx;
 316 #ifdef RESOURCE_TRACK
 317         /*
 318          * For timing purposes
 319          */
 320         struct resource_track   global_rtrack;
 321 #endif
 322
 323         /*
 324          * How we display the progress update (for unix)
 325          */
 326         int progress_fd;
 327         int progress_pos;
 328         int progress_last_percent;
 329         unsigned int progress_last_time;
 330         int interactive;        /* Are we connected directly to a tty? */
 331         char start_meta[2], stop_meta[2];
 332
 333         /* File counts */
 334         __u32 fs_directory_count;
 335         __u32 fs_regular_count;
 336         __u32 fs_blockdev_count;
 337         __u32 fs_chardev_count;
 338         __u32 fs_links_count;
 339         __u32 fs_symlinks_count;
 340         __u32 fs_fast_symlinks_count;
 341         __u32 fs_fifo_count;
 342         __u32 fs_total_count;
 343         __u32 fs_badblocks_count;
 344         __u32 fs_sockets_count;
 345         __u32 fs_ind_count;
 346         __u32 fs_dind_count;
 347         __u32 fs_tind_count;
 348         __u32 fs_fragmented;
 349         __u32 fs_fragmented_dir;
 350         __u32 large_files;
 351         __u32 fs_ext_attr_inodes;
 352         __u32 fs_ext_attr_blocks;
 353         __u32 extent_depth_count[MAX_EXTENT_DEPTH_COUNT];
 354
 355         /* misc fields */
 356         time_t now;
 357         time_t time_fudge;      /* For working around buggy init scripts */
 358         int ext_attr_ver;
 359         profile_t       profile;
 360         int blocks_per_page;
 361
 362         /*
 363          * For the use of callers of the e2fsck functions; not used by
 364          * e2fsck functions themselves.
 365          */
 366         void *priv_data;
 367 };
 368
 369 /* Used by the region allocation code */
 370 typedef __u32 region_addr_t;
 371 typedef struct region_struct *region_t;
 372
 373 #ifndef HAVE_STRNLEN
 374 #define strnlen(str, x) e2fsck_strnlen((str),(x))
 375 extern int e2fsck_strnlen(const char * s, int count);
 376 #endif
 377
 378 /*
 379  * Procedure declarations
 380  */
 381
 382 extern void e2fsck_pass1(e2fsck_t ctx);
 383 extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf);
 384 extern void e2fsck_pass2(e2fsck_t ctx);
 385 extern void e2fsck_pass3(e2fsck_t ctx);
 386 extern void e2fsck_pass4(e2fsck_t ctx);
 387 extern void e2fsck_pass5(e2fsck_t ctx);
 388
 389 /* e2fsck.c */
 390 extern errcode_t e2fsck_allocate_context(e2fsck_t *ret);
 391 extern errcode_t e2fsck_reset_context(e2fsck_t ctx);
 392 extern void e2fsck_free_context(e2fsck_t ctx);
 393 extern int e2fsck_run(e2fsck_t ctx);
 394
 395
 396 /* badblock.c */
 397 extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
 398                                  int replace_bad_blocks);
 399
 400 /* crc32.c */
 401 extern __u32 crc32_be(__u32 crc, unsigned char const *p, size_t len);
 402
 403 /* dirinfo.c */
 404 extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent);
 405 extern void e2fsck_free_dir_info(e2fsck_t ctx);
 406 extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
 407 extern struct dir_info_iter *e2fsck_dir_info_iter_begin(e2fsck_t ctx);
 408 extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx,
 409                                              struct dir_info_iter *);
 410 extern void e2fsck_dir_info_iter_end(e2fsck_t ctx, struct dir_info_iter *);
 411 extern int e2fsck_dir_info_set_parent(e2fsck_t ctx, ext2_ino_t ino,
 412                                       ext2_ino_t parent);
 413 extern int e2fsck_dir_info_set_dotdot(e2fsck_t ctx, ext2_ino_t ino,
 414                                       ext2_ino_t dotdot);
 415 extern int e2fsck_dir_info_get_parent(e2fsck_t ctx, ext2_ino_t ino,
 416                                       ext2_ino_t *parent);
 417 extern int e2fsck_dir_info_get_dotdot(e2fsck_t ctx, ext2_ino_t ino,
 418                                       ext2_ino_t *dotdot);
 419
 420 /* dx_dirinfo.c */
 421 extern void e2fsck_add_dx_dir(e2fsck_t ctx, ext2_ino_t ino, int num_blocks);
 422 extern struct dx_dir_info *e2fsck_get_dx_dir_info(e2fsck_t ctx, ext2_ino_t ino);
 423 extern void e2fsck_free_dx_dir_info(e2fsck_t ctx);
 424 extern int e2fsck_get_num_dx_dirinfo(e2fsck_t ctx);
 425 extern struct dx_dir_info *e2fsck_dx_dir_info_iter(e2fsck_t ctx, int *control);
 426
 427 /* ea_refcount.c */
 428 extern errcode_t ea_refcount_create(int size, ext2_refcount_t *ret);
 429 extern void ea_refcount_free(ext2_refcount_t refcount);
 430 extern errcode_t ea_refcount_fetch(ext2_refcount_t refcount, blk_t blk,
 431                                    int *ret);
 432 extern errcode_t ea_refcount_increment(ext2_refcount_t refcount,
 433                                        blk_t blk, int *ret);
 434 extern errcode_t ea_refcount_decrement(ext2_refcount_t refcount,
 435                                        blk_t blk, int *ret);
 436 extern errcode_t ea_refcount_store(ext2_refcount_t refcount,
 437                                    blk_t blk, int count);
 438 extern blk_t ext2fs_get_refcount_size(ext2_refcount_t refcount);
 439 extern void ea_refcount_intr_begin(ext2_refcount_t refcount);
 440 extern blk_t ea_refcount_intr_next(ext2_refcount_t refcount, int *ret);
 441
 442 /* ehandler.c */
 443 extern const char *ehandler_operation(const char *op);
 444 extern void ehandler_init(io_channel channel);
 445
 446 /* journal.c */
 447 extern int e2fsck_check_ext3_journal(e2fsck_t ctx);
 448 extern int e2fsck_run_ext3_journal(e2fsck_t ctx);
 449 extern void e2fsck_move_ext3_journal(e2fsck_t ctx);
 450 extern int e2fsck_fix_ext3_journal_hint(e2fsck_t ctx);
 451
 452 /* quota.c */
 453 extern void e2fsck_hide_quota(e2fsck_t ctx);
 454
 455 /* pass1.c */
 456 extern void e2fsck_setup_tdb_icount(e2fsck_t ctx, int flags,
 457                                     ext2_icount_t *ret);
 458 extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int bool);
 459 extern int e2fsck_pass1_check_device_inode(ext2_filsys fs,
 460                                            struct ext2_inode *inode);
 461 extern int e2fsck_pass1_check_symlink(ext2_filsys fs, ext2_ino_t ino,
 462                                       struct ext2_inode *inode, char *buf);
 463 extern void e2fsck_clear_inode(e2fsck_t ctx, ext2_ino_t ino,
 464                                struct ext2_inode *inode, int restart_flag,
 465                                const char *source);
 466
 467 /* pass2.c */
 468 extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir,
 469                                     ext2_ino_t ino, char *buf);
 470
 471 /* pass3.c */
 472 extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode);
 473 extern errcode_t e2fsck_expand_directory(e2fsck_t ctx, ext2_ino_t dir,
 474                                          int num, int gauranteed_size);
 475 extern ext2_ino_t e2fsck_get_lost_and_found(e2fsck_t ctx, int fix);
 476 extern errcode_t e2fsck_adjust_inode_count(e2fsck_t ctx, ext2_ino_t ino,
 477                                            int adj);
 478
 479
 480 /* region.c */
 481 extern region_t region_create(region_addr_t min, region_addr_t max);
 482 extern void region_free(region_t region);
 483 extern int region_allocate(region_t region, region_addr_t start, int n);
 484
 485 /* rehash.c */
 486 errcode_t e2fsck_rehash_dir(e2fsck_t ctx, ext2_ino_t ino);
 487 void e2fsck_rehash_directories(e2fsck_t ctx);
 488
 489 /* sigcatcher.c */
 490 void sigcatcher_setup(void);
 491
 492 /* super.c */
 493 void check_super_block(e2fsck_t ctx);
 494 int check_backup_super_block(e2fsck_t ctx);
 495 void check_resize_inode(e2fsck_t ctx);
 496
 497 /* util.c */
 498 extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
 499                                     const char *description);
 500 extern int ask(e2fsck_t ctx, const char * string, int def);
 501 extern int ask_yn(const char * string, int def);
 502 extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
 503 extern void e2fsck_read_bitmaps(e2fsck_t ctx);
 504 extern void e2fsck_write_bitmaps(e2fsck_t ctx);
 505 extern void preenhalt(e2fsck_t ctx);
 506 extern char *string_copy(e2fsck_t ctx, const char *str, int len);
 507 extern errcode_t e2fsck_zero_blocks(ext2_filsys fs, blk_t blk, int num,
 508                                     blk_t *ret_blk, int *ret_count);
 509 extern int fs_proc_check(const char *fs_name);
 510 extern int check_for_modules(const char *fs_name);
 511 #ifdef RESOURCE_TRACK
 512 extern void print_resource_track(e2fsck_t ctx,
 513                                  const char *desc,
 514                                  struct resource_track *track,
 515                                  io_channel channel);
 516 extern void init_resource_track(struct resource_track *track,
 517                                 io_channel channel);
 518 #else
 519 #define print_resource_track(ctx, desc, track, channel) do { } while (0)
 520 #define init_resource_track(track, channel) do { } while (0)
 521 #endif
 522 extern int inode_has_valid_blocks(struct ext2_inode *inode);
 523 extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
 524                               struct ext2_inode * inode, const char * proc);
 525 extern void e2fsck_read_inode_full(e2fsck_t ctx, unsigned long ino,
 526                                    struct ext2_inode *inode,
 527                                    const int bufsize, const char *proc);
 528 extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
 529                                struct ext2_inode * inode, const char * proc);
 530 extern void e2fsck_write_inode_full(e2fsck_t ctx, unsigned long ino,
 531                                struct ext2_inode * inode, int bufsize,
 532                                const char *proc);
 533 #ifdef MTRACE
 534 extern void mtrace_print(char *mesg);
 535 #endif
 536 extern blk_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs,
 537                            const char *name, io_manager manager);
 538 extern int ext2_file_type(unsigned int mode);
 539 extern int write_all(int fd, char *buf, size_t count);
 540 void dump_mmp_msg(struct mmp_struct *mmp, const char *msg);
 541 errcode_t e2fsck_mmp_update(ext2_filsys fs);
 542
 543 extern void e2fsck_set_bitmap_type(ext2_filsys fs,
 544                                    unsigned int default_type,
 545                                    const char *profile_name,
 546                                    unsigned int *old_type);
 547 extern errcode_t e2fsck_allocate_inode_bitmap(ext2_filsys fs,
 548                                               const char *descr,
 549                                               int default_type,
 550                                               const char *profile_name,
 551                                               ext2fs_inode_bitmap *ret);
 552 extern errcode_t e2fsck_allocate_block_bitmap(ext2_filsys fs,
 553                                               const char *descr,
 554                                               int default_type,
 555                                               const char *profile_name,
 556                                               ext2fs_block_bitmap *ret);
 557 extern errcode_t e2fsck_allocate_subcluster_bitmap(ext2_filsys fs,
 558                                                    const char *descr,
 559                                                    int default_type,
 560                                                    const char *profile_name,
 561                                                    ext2fs_block_bitmap *ret);
 562
 563 /* unix.c */
 564 extern void e2fsck_clear_progbar(e2fsck_t ctx);
 565 extern int e2fsck_simple_progress(e2fsck_t ctx, const char *label,
 566                                   float percent, unsigned int dpynum);
 567 #endif /* _E2FSCK_H */