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