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 <linux/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  * This is the global e2fsck structure.
 131  */
 132 typedef struct e2fsck_struct *e2fsck_t;
 133
 134 struct e2fsck_struct {
 135         ext2_filsys fs;
 136         const char *program_name;
 137         const char *filesystem_name;
 138         const char *device_name;
 139         int     flags;          /* E2fsck internal flags */
 140         int     options;
 141         blk_t   use_superblock; /* sb requested by user */
 142         blk_t   superblock;     /* sb used to open fs */
 143         blk_t   num_blocks;     /* Total number of blocks */
 144
 145 #ifdef HAVE_SETJMP_H
 146         jmp_buf abort_loc;
 147 #endif
 148         unsigned long abort_code;
 149
 150         int (*progress)(e2fsck_t ctx, int pass, unsigned long cur,
 151                         unsigned long max);
 152
 153         ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */
 154         ext2fs_inode_bitmap inode_bad_map; /* Inodes which are bad somehow */
 155         ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */
 156         ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */
 157         ext2fs_inode_bitmap inode_imagic_map; /* AFS inodes */
 158         ext2fs_inode_bitmap inode_reg_map; /* Inodes which are regular files*/
 159
 160         ext2fs_block_bitmap block_found_map; /* Blocks which are in use */
 161         ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */
 162
 163         /*
 164          * Inode count arrays
 165          */
 166         ext2_icount_t   inode_count;
 167         ext2_icount_t inode_link_info;
 168
 169         /*
 170          * Array of flags indicating whether an inode bitmap, block
 171          * bitmap, or inode table is invalid
 172          */
 173         int *invalid_inode_bitmap_flag;
 174         int *invalid_block_bitmap_flag;
 175         int *invalid_inode_table_flag;
 176         int invalid_bitmaps;    /* There are invalid bitmaps/itable */
 177
 178         /*
 179          * Block buffer
 180          */
 181         char *block_buf;
 182
 183         /*
 184          * For pass1_check_directory and pass1_get_blocks
 185          */
 186         ext2_ino_t stashed_ino;
 187         struct ext2_inode *stashed_inode;
 188
 189         /*
 190          * Directory information
 191          */
 192         int             dir_info_count;
 193         int             dir_info_size;
 194         struct dir_info *dir_info;
 195
 196         /*
 197          * Tuning parameters
 198          */
 199         int process_inode_size;
 200         int inode_buffer_blocks;
 201
 202 #ifdef RESOURCE_TRACK
 203         /*
 204          * For timing purposes
 205          */
 206         struct resource_track   global_rtrack;
 207 #endif
 208
 209         /*
 210          * How we display the progress update (for unix)
 211          */
 212         int progress_fd;
 213         int progress_pos;
 214         int progress_last_percent;
 215         unsigned int progress_last_time;
 216
 217         /* File counts */
 218         int fs_directory_count;
 219         int fs_regular_count;
 220         int fs_blockdev_count;
 221         int fs_chardev_count;
 222         int fs_links_count;
 223         int fs_symlinks_count;
 224         int fs_fast_symlinks_count;
 225         int fs_fifo_count;
 226         int fs_total_count;
 227         int fs_badblocks_count;
 228         int fs_sockets_count;
 229         int fs_ind_count;
 230         int fs_dind_count;
 231         int fs_tind_count;
 232         int fs_fragmented;
 233         int large_files;
 234
 235         /*
 236          * For the use of callers of the e2fsck functions; not used by
 237          * e2fsck functions themselves.
 238          */
 239         void *priv_data;
 240 };
 241
 242
 243 /*
 244  * Procedure declarations
 245  */
 246
 247 extern void e2fsck_pass1(e2fsck_t ctx);
 248 extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf);
 249 extern void e2fsck_pass2(e2fsck_t ctx);
 250 extern void e2fsck_pass3(e2fsck_t ctx);
 251 extern void e2fsck_pass4(e2fsck_t ctx);
 252 extern void e2fsck_pass5(e2fsck_t ctx);
 253
 254 /* e2fsck.c */
 255 extern errcode_t e2fsck_allocate_context(e2fsck_t *ret);
 256 extern errcode_t e2fsck_reset_context(e2fsck_t ctx);
 257 extern void e2fsck_free_context(e2fsck_t ctx);
 258 extern int e2fsck_run(e2fsck_t ctx);
 259
 260
 261 /* badblock.c */
 262 extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
 263                                  int replace_bad_blocks);
 264 extern void test_disk(e2fsck_t ctx);
 265
 266 /* dirinfo.c */
 267 extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent);
 268 extern struct dir_info *e2fsck_get_dir_info(e2fsck_t ctx, ext2_ino_t ino);
 269 extern void e2fsck_free_dir_info(e2fsck_t ctx);
 270 extern int e2fsck_get_num_dirs(e2fsck_t ctx);
 271 extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
 272 extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx, int *control);
 273
 274 /* ehandler.c */
 275 extern const char *ehandler_operation(const char *op);
 276 extern void ehandler_init(io_channel channel);
 277
 278 /* journal.c */
 279 extern int e2fsck_check_ext3_journal(e2fsck_t ctx);
 280 extern int e2fsck_run_ext3_journal(e2fsck_t ctx);
 281
 282 /* pass1.c */
 283 extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int bool);
 284 extern int e2fsck_pass1_check_device_inode(struct ext2_inode *inode);
 285
 286 /* pass2.c */
 287 extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir, ext2_ino_t ino);
 288
 289 /* pass3.c */
 290 extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode);
 291
 292 /* super.c */
 293 void check_super_block(e2fsck_t ctx);
 294 errcode_t e2fsck_get_device_size(e2fsck_t ctx);
 295
 296 /* swapfs.c */
 297 void swap_filesys(e2fsck_t ctx);
 298
 299 /* util.c */
 300 extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
 301                                     const char *description);
 302 extern int ask(e2fsck_t ctx, const char * string, int def);
 303 extern int ask_yn(const char * string, int def);
 304 extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
 305 extern void e2fsck_read_bitmaps(e2fsck_t ctx);
 306 extern void e2fsck_write_bitmaps(e2fsck_t ctx);
 307 extern void preenhalt(e2fsck_t ctx);
 308 #ifdef RESOURCE_TRACK
 309 extern void print_resource_track(const char *desc,
 310                                  struct resource_track *track);
 311 extern void init_resource_track(struct resource_track *track);
 312 #endif
 313 extern int inode_has_valid_blocks(struct ext2_inode *inode);
 314 extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
 315                               struct ext2_inode * inode, const char * proc);
 316 extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
 317                                struct ext2_inode * inode, const char * proc);
 318 #ifdef MTRACE
 319 extern void mtrace_print(char *mesg);
 320 #endif
 321 extern blk_t get_backup_sb(ext2_filsys fs);
 322 extern int ext2_file_type(unsigned int mode);
 323
 324 /* unix.c */
 325 extern void e2fsck_clear_progbar(e2fsck_t ctx);