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