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