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