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_LIBRARY     128    /* Shared library error */
  62
  63 /*
  64  * The last ext2fs revision level that this version of e2fsck is able to
  65  * support
  66  */
  67 #define E2FSCK_CURRENT_REV      1
  68
  69 /*
  70  * The directory information structure; stores directory information
  71  * collected in earlier passes, to avoid disk i/o in fetching the
  72  * directory information.
  73  */
  74 struct dir_info {
  75         ext2_ino_t              ino;    /* Inode number */
  76         ext2_ino_t              dotdot; /* Parent according to '..' */
  77         ext2_ino_t              parent; /* Parent according to treewalk */
  78 };
  79
  80 #ifdef RESOURCE_TRACK
  81 /*
  82  * This structure is used for keeping track of how much resources have
  83  * been used for a particular pass of e2fsck.
  84  */
  85 struct resource_track {
  86         struct timeval time_start;
  87         struct timeval user_start;
  88         struct timeval system_start;
  89         void    *brk_start;
  90 };
  91 #endif
  92
  93 /*
  94  * E2fsck options
  95  */
  96 #define E2F_OPT_READONLY        0x0001
  97 #define E2F_OPT_PREEN           0x0002
  98 #define E2F_OPT_YES             0x0004
  99 #define E2F_OPT_NO              0x0008
 100 #define E2F_OPT_TIME            0x0010
 101 #define E2F_OPT_TIME2           0x0020
 102 #define E2F_OPT_CHECKBLOCKS     0x0040
 103 #define E2F_OPT_DEBUG           0x0080
 104
 105 /*
 106  * E2fsck flags
 107  */
 108 #define E2F_FLAG_ABORT          0x0001 /* Abort signaled */
 109 #define E2F_FLAG_CANCEL         0x0002 /* Cancel signaled */
 110 #define E2F_FLAG_SIGNAL_MASK    0x0003
 111 #define E2F_FLAG_RESTART        0x0004 /* Restart signaled */
 112
 113 #define E2F_FLAG_SETJMP_OK      0x0010 /* Setjmp valid for abort */
 114
 115 #define E2F_FLAG_PROG_BAR       0x0020 /* Progress bar on screen */
 116 #define E2F_FLAG_PROG_SUPPRESS  0x0040 /* Progress suspended */
 117 #define E2F_FLAG_JOURNAL_INODE  0x0080 /* Create a new ext3 journal inode */
 118
 119 /*
 120  * Defines for indicating the e2fsck pass number
 121  */
 122 #define E2F_PASS_1      1
 123 #define E2F_PASS_2      2
 124 #define E2F_PASS_3      3
 125 #define E2F_PASS_4      4
 126 #define E2F_PASS_5      5
 127 #define E2F_PASS_1B     6
 128
 129 /*
 130  * Define the extended attribute refcount structure
 131  */
 132 typedef struct ea_refcount *ext2_refcount_t;
 133
 134 /*
 135  * This is the global e2fsck structure.
 136  */
 137 typedef struct e2fsck_struct *e2fsck_t;
 138
 139 struct e2fsck_struct {
 140         ext2_filsys fs;
 141         const char *program_name;
 142         const char *filesystem_name;
 143         const char *device_name;
 144         int     flags;          /* E2fsck internal flags */
 145         int     options;
 146         blk_t   use_superblock; /* sb requested by user */
 147         blk_t   superblock;     /* sb used to open fs */
 148         blk_t   num_blocks;     /* Total number of blocks */
 149
 150 #ifdef HAVE_SETJMP_H
 151         jmp_buf abort_loc;
 152 #endif
 153         unsigned long abort_code;
 154
 155         int (*progress)(e2fsck_t ctx, int pass, unsigned long cur,
 156                         unsigned long max);
 157
 158         ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */
 159         ext2fs_inode_bitmap inode_bad_map; /* Inodes which are bad somehow */
 160         ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */
 161         ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */
 162         ext2fs_inode_bitmap inode_imagic_map; /* AFS inodes */
 163         ext2fs_inode_bitmap inode_reg_map; /* Inodes which are regular files*/
 164
 165         ext2fs_block_bitmap block_found_map; /* Blocks which are in use */
 166         ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */
 167         ext2fs_block_bitmap block_ea_map; /* Blocks which are used by EA's */
 168
 169         /*
 170          * Inode count arrays
 171          */
 172         ext2_icount_t   inode_count;
 173         ext2_icount_t inode_link_info;
 174
 175         ext2_refcount_t refcount;
 176         ext2_refcount_t refcount_extra;
 177
 178         /*
 179          * Array of flags indicating whether an inode bitmap, block
 180          * bitmap, or inode table is invalid
 181          */
 182         int *invalid_inode_bitmap_flag;
 183         int *invalid_block_bitmap_flag;
 184         int *invalid_inode_table_flag;
 185         int invalid_bitmaps;    /* There are invalid bitmaps/itable */
 186
 187         /*
 188          * Block buffer
 189          */
 190         char *block_buf;
 191
 192         /*
 193          * For pass1_check_directory and pass1_get_blocks
 194          */
 195         ext2_ino_t stashed_ino;
 196         struct ext2_inode *stashed_inode;
 197
 198         /*
 199          * Directory information
 200          */
 201         int             dir_info_count;
 202         int             dir_info_size;
 203         struct dir_info *dir_info;
 204
 205         /*
 206          * Tuning parameters
 207          */
 208         int process_inode_size;
 209         int inode_buffer_blocks;
 210
 211         /*
 212          * ext3 journal support
 213          */
 214         io_channel      journal_io;
 215         const char      *journal_name;
 216
 217 #ifdef RESOURCE_TRACK
 218         /*
 219          * For timing purposes
 220          */
 221         struct resource_track   global_rtrack;
 222 #endif
 223
 224         /*
 225          * How we display the progress update (for unix)
 226          */
 227         int progress_fd;
 228         int progress_pos;
 229         int progress_last_percent;
 230         unsigned int progress_last_time;
 231
 232         /* File counts */
 233         int fs_directory_count;
 234         int fs_regular_count;
 235         int fs_blockdev_count;
 236         int fs_chardev_count;
 237         int fs_links_count;
 238         int fs_symlinks_count;
 239         int fs_fast_symlinks_count;
 240         int fs_fifo_count;
 241         int fs_total_count;
 242         int fs_badblocks_count;
 243         int fs_sockets_count;
 244         int fs_ind_count;
 245         int fs_dind_count;
 246         int fs_tind_count;
 247         int fs_fragmented;
 248         int large_files;
 249         int fs_ext_attr_inodes;
 250         int fs_ext_attr_blocks;
 251
 252         /*
 253          * For the use of callers of the e2fsck functions; not used by
 254          * e2fsck functions themselves.
 255          */
 256         void *priv_data;
 257 };
 258
 259 /* Used by the region allocation code */
 260 typedef __u32 region_addr_t;
 261 typedef struct region_struct *region_t;
 262
 263 /*
 264  * Procedure declarations
 265  */
 266
 267 extern void e2fsck_pass1(e2fsck_t ctx);
 268 extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf);
 269 extern void e2fsck_pass2(e2fsck_t ctx);
 270 extern void e2fsck_pass3(e2fsck_t ctx);
 271 extern void e2fsck_pass4(e2fsck_t ctx);
 272 extern void e2fsck_pass5(e2fsck_t ctx);
 273
 274 /* e2fsck.c */
 275 extern errcode_t e2fsck_allocate_context(e2fsck_t *ret);
 276 extern errcode_t e2fsck_reset_context(e2fsck_t ctx);
 277 extern void e2fsck_free_context(e2fsck_t ctx);
 278 extern int e2fsck_run(e2fsck_t ctx);
 279
 280
 281 /* badblock.c */
 282 extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
 283                                  int replace_bad_blocks);
 284 extern void test_disk(e2fsck_t ctx);
 285
 286 /* dirinfo.c */
 287 extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent);
 288 extern struct dir_info *e2fsck_get_dir_info(e2fsck_t ctx, ext2_ino_t ino);
 289 extern void e2fsck_free_dir_info(e2fsck_t ctx);
 290 extern int e2fsck_get_num_dirs(e2fsck_t ctx);
 291 extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
 292 extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx, int *control);
 293
 294 /* ea_refcount.c */
 295 extern errcode_t ea_refcount_create(int size, ext2_refcount_t *ret);
 296 extern void ea_refcount_free(ext2_refcount_t refcount);
 297 extern errcode_t ea_refcount_fetch(ext2_refcount_t refcount, blk_t blk,
 298                                    int *ret);
 299 extern errcode_t ea_refcount_increment(ext2_refcount_t refcount,
 300                                        blk_t blk, int *ret);
 301 extern errcode_t ea_refcount_decrement(ext2_refcount_t refcount,
 302                                        blk_t blk, int *ret);
 303 extern errcode_t ea_refcount_store(ext2_refcount_t refcount,
 304                                    blk_t blk, int count);
 305 extern void ea_refcount_intr_begin(ext2_refcount_t refcount);
 306 extern blk_t ea_refcount_intr_next(ext2_refcount_t refcount, int *ret);
 307
 308 /* ehandler.c */
 309 extern const char *ehandler_operation(const char *op);
 310 extern void ehandler_init(io_channel channel);
 311
 312 /* journal.c */
 313 extern int e2fsck_check_ext3_journal(e2fsck_t ctx);
 314 extern int e2fsck_run_ext3_journal(e2fsck_t ctx);
 315
 316 /* pass1.c */
 317 extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int bool);
 318 extern int e2fsck_pass1_check_device_inode(struct ext2_inode *inode);
 319 extern int e2fsck_pass1_check_symlink(ext2_filsys fs, struct ext2_inode *inode);
 320
 321 /* pass2.c */
 322 extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir, ext2_ino_t ino);
 323
 324 /* pass3.c */
 325 extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode);
 326
 327 /* region.c */
 328 extern region_t region_create(region_addr_t min, region_addr_t max);
 329 extern void region_free(region_t region);
 330 extern int region_allocate(region_t region, region_addr_t start, int n);
 331
 332 /* super.c */
 333 void check_super_block(e2fsck_t ctx);
 334 errcode_t e2fsck_get_device_size(e2fsck_t ctx);
 335
 336 /* swapfs.c */
 337 void swap_filesys(e2fsck_t ctx);
 338
 339 /* util.c */
 340 extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
 341                                     const char *description);
 342 extern int ask(e2fsck_t ctx, const char * string, int def);
 343 extern int ask_yn(const char * string, int def);
 344 extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
 345 extern void e2fsck_read_bitmaps(e2fsck_t ctx);
 346 extern void e2fsck_write_bitmaps(e2fsck_t ctx);
 347 extern void preenhalt(e2fsck_t ctx);
 348 #ifdef RESOURCE_TRACK
 349 extern void print_resource_track(const char *desc,
 350                                  struct resource_track *track);
 351 extern void init_resource_track(struct resource_track *track);
 352 #endif
 353 extern int inode_has_valid_blocks(struct ext2_inode *inode);
 354 extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
 355                               struct ext2_inode * inode, const char * proc);
 356 extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
 357                                struct ext2_inode * inode, const char * proc);
 358 #ifdef MTRACE
 359 extern void mtrace_print(char *mesg);
 360 #endif
 361 extern blk_t get_backup_sb(ext2_filsys fs);
 362 extern int ext2_file_type(unsigned int mode);
 363
 364 /* unix.c */
 365 extern void e2fsck_clear_progbar(e2fsck_t ctx);