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