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 #include <unistd.h>
  12 #include <stdlib.h>
  13 #ifdef HAVE_SYS_TYPES_H
  14 #include <sys/types.h>
  15 #endif
  16 #ifdef HAVE_SYS_TIME_H
  17 #include <sys/time.h>
  18 #endif
  19 #ifdef HAVE_SETJMP_H
  20 #include <setjmp.h>
  21 #endif
  22
  23 #ifdef HAVE_LINUX_FS_H
  24 #include <linux/fs.h>
  25 #endif
  26
  27 #if EXT2_FLAT_INCLUDES
  28 #include "ext2_fs.h"
  29 #include "ext2fs.h"
  30 #else
  31 #include <linux/ext2_fs.h>
  32 #include "ext2fs/ext2fs.h"
  33 #endif
  34
  35
  36 /* Everything is STDC, these days */
  37 #define NOARGS void
  38
  39 /*
  40  * Exit codes used by fsck-type programs
  41  */
  42 #define FSCK_OK          0      /* No errors */
  43 #define FSCK_NONDESTRUCT 1      /* File system errors corrected */
  44 #define FSCK_REBOOT      2      /* System should be rebooted */
  45 #define FSCK_UNCORRECTED 4      /* File system errors left uncorrected */
  46 #define FSCK_ERROR       8      /* Operational error */
  47 #define FSCK_USAGE       16     /* Usage or syntax error */
  48 #define FSCK_LIBRARY     128    /* Shared library error */
  49
  50 /*
  51  * The last ext2fs revision level that this version of e2fsck is able to
  52  * support
  53  */
  54 #define E2FSCK_CURRENT_REV      1
  55
  56 /*
  57  * The directory information structure; stores directory information
  58  * collected in earlier passes, to avoid disk i/o in fetching the
  59  * directory information.
  60  */
  61 struct dir_info {
  62         ino_t                   ino;    /* Inode number */
  63         ino_t                   dotdot; /* Parent according to '..' */
  64         ino_t                   parent; /* Parent according to treewalk */
  65 };
  66
  67 #ifdef RESOURCE_TRACK
  68 /*
  69  * This structure is used for keeping track of how much resources have
  70  * been used for a particular pass of e2fsck.
  71  */
  72 struct resource_track {
  73         struct timeval time_start;
  74         struct timeval user_start;
  75         struct timeval system_start;
  76         void    *brk_start;
  77 };
  78 #endif
  79
  80 /*
  81  * E2fsck options
  82  */
  83 #define E2F_OPT_READONLY        0x0001
  84 #define E2F_OPT_PREEN           0x0002
  85 #define E2F_OPT_YES             0x0004
  86 #define E2F_OPT_NO              0x0008
  87 #define E2F_OPT_TIME            0x0010
  88 #define E2F_OPT_TIME2           0x0020
  89 #define E2F_OPT_CHECKBLOCKS     0x0040
  90 #define E2F_OPT_DEBUG           0x0080
  91
  92 /*
  93  * E2fsck flags
  94  */
  95 #define E2F_FLAG_ABORT          0x0001 /* Abort signaled */
  96 #define E2F_FLAG_CANCEL         0x0002 /* Cancel signaled */
  97 #define E2F_FLAG_RESTART        0x0004 /* Restart signaled */
  98 #define E2F_FLAG_SIGNAL_MASK    0x000F
  99
 100 #define E2F_FLAG_SETJMP_OK      0x0010 /* Setjmp valid for abort */
 101
 102 /*
 103  * Defines for indicating the e2fsck pass number
 104  */
 105 #define E2F_PASS_1      1
 106 #define E2F_PASS_2      2
 107 #define E2F_PASS_3      3
 108 #define E2F_PASS_4      4
 109 #define E2F_PASS_5      5
 110 #define E2F_PASS_1B     6
 111
 112 /*
 113  * This is the global e2fsck structure.
 114  */
 115 typedef struct e2fsck_struct *e2fsck_t;
 116
 117 struct e2fsck_struct {
 118         ext2_filsys fs;
 119         const char *program_name;
 120         const char *filesystem_name;
 121         const char *device_name;
 122         int     flags;          /* E2fsck internal flags */
 123         int     options;
 124         blk_t   use_superblock; /* sb requested by user */
 125         blk_t   superblock;     /* sb used to open fs */
 126         blk_t   num_blocks;     /* Total number of blocks */
 127
 128 #ifdef HAVE_SETJMP_H
 129         jmp_buf abort_loc;
 130 #endif
 131         unsigned long abort_code;
 132
 133         void (*progress)(e2fsck_t ctx, int pass, unsigned long cur,
 134                          unsigned long max);
 135
 136         ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */
 137         ext2fs_inode_bitmap inode_bad_map; /* Inodes which are bad somehow */
 138         ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */
 139         ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */
 140
 141         ext2fs_block_bitmap block_found_map; /* Blocks which are in use */
 142         ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */
 143         ext2fs_block_bitmap block_illegal_map; /* Meta-data blocks */
 144
 145         /*
 146          * Inode count arrays
 147          */
 148         ext2_icount_t   inode_count;
 149         ext2_icount_t inode_link_info;
 150
 151         /*
 152          * Array of flags indicating whether an inode bitmap, block
 153          * bitmap, or inode table is invalid
 154          */
 155         int *invalid_inode_bitmap_flag;
 156         int *invalid_block_bitmap_flag;
 157         int *invalid_inode_table_flag;
 158         int invalid_bitmaps;    /* There are invalid bitmaps/itable */
 159
 160         /*
 161          * Block buffer
 162          */
 163         char *block_buf;
 164
 165         /*
 166          * For pass1_check_directory and pass1_get_blocks
 167          */
 168         ino_t stashed_ino;
 169         struct ext2_inode *stashed_inode;
 170
 171         /*
 172          * Directory information
 173          */
 174         int             dir_info_count;
 175         int             dir_info_size;
 176         struct dir_info *dir_info;
 177
 178         /*
 179          * Tuning parameters
 180          */
 181         int process_inode_size;
 182         int inode_buffer_blocks;
 183
 184 #ifdef RESOURCE_TRACK
 185         /*
 186          * For timing purposes
 187          */
 188         struct resource_track   global_rtrack;
 189 #endif
 190
 191         /* File counts */
 192         int fs_directory_count;
 193         int fs_regular_count;
 194         int fs_blockdev_count;
 195         int fs_chardev_count;
 196         int fs_links_count;
 197         int fs_symlinks_count;
 198         int fs_fast_symlinks_count;
 199         int fs_fifo_count;
 200         int fs_total_count;
 201         int fs_badblocks_count;
 202         int fs_sockets_count;
 203         int fs_ind_count;
 204         int fs_dind_count;
 205         int fs_tind_count;
 206         int fs_fragmented;
 207 };
 208
 209
 210 /*
 211  * Procedure declarations
 212  */
 213
 214 extern void e2fsck_pass1(e2fsck_t ctx);
 215 extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf);
 216 extern void e2fsck_pass2(e2fsck_t ctx);
 217 extern void e2fsck_pass3(e2fsck_t ctx);
 218 extern void e2fsck_pass4(e2fsck_t ctx);
 219 extern void e2fsck_pass5(e2fsck_t ctx);
 220
 221 /* e2fsck.c */
 222 extern errcode_t e2fsck_allocate_context(e2fsck_t *ret);
 223 extern errcode_t e2fsck_reset_context(e2fsck_t ctx);
 224 extern void e2fsck_free_context(e2fsck_t ctx);
 225 extern int e2fsck_run(e2fsck_t ctx);
 226
 227
 228 /* pass1.c */
 229 extern errcode_t pass1_check_directory(ext2_filsys fs, ino_t ino);
 230 extern errcode_t pass1_get_blocks(ext2_filsys fs, ino_t ino, blk_t *blocks);
 231 extern errcode_t pass1_read_inode(ext2_filsys fs, ino_t ino,
 232                                   struct ext2_inode *inode);
 233 extern errcode_t pass1_write_inode(ext2_filsys fs, ino_t ino,
 234                                    struct ext2_inode *inode);
 235 extern int e2fsck_pass1_check_device_inode(struct ext2_inode *inode);
 236
 237 /* badblock.c */
 238 extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
 239                                  int replace_bad_blocks);
 240 extern void test_disk(e2fsck_t ctx);
 241
 242 /* dirinfo.c */
 243 extern void e2fsck_add_dir_info(e2fsck_t ctx, ino_t ino, ino_t parent);
 244 extern struct dir_info *e2fsck_get_dir_info(e2fsck_t ctx, ino_t ino);
 245 extern void e2fsck_free_dir_info(e2fsck_t ctx);
 246 extern int e2fsck_get_num_dirs(e2fsck_t ctx);
 247 extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
 248 extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx, int *control);
 249
 250 /* ehandler.c */
 251 extern const char *ehandler_operation(const char *op);
 252 extern void ehandler_init(io_channel channel);
 253
 254 /* super.c */
 255 void check_super_block(e2fsck_t ctx);
 256
 257 /* swapfs.c */
 258 void swap_filesys(e2fsck_t ctx);
 259
 260 /* util.c */
 261 extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
 262                                     const char *description);
 263 extern int ask(e2fsck_t ctx, const char * string, int def);
 264 extern int ask_yn(const char * string, int def);
 265 extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
 266 extern void e2fsck_read_bitmaps(e2fsck_t ctx);
 267 extern void e2fsck_write_bitmaps(e2fsck_t ctx);
 268 extern void preenhalt(e2fsck_t ctx);
 269 #ifdef RESOURCE_TRACK
 270 extern void print_resource_track(const char *desc,
 271                                  struct resource_track *track);
 272 extern void init_resource_track(struct resource_track *track);
 273 #endif
 274 extern int inode_has_valid_blocks(struct ext2_inode *inode);
 275 extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
 276                               struct ext2_inode * inode, const char * proc);
 277 extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
 278                                struct ext2_inode * inode, const char * proc);
 279 #ifdef MTRACE
 280 extern void mtrace_print(char *mesg);
 281 #endif
 282 extern blk_t get_backup_sb(ext2_filsys fs);
 283
 284 /*
 285  * pass3.c
 286  */
 287 extern int e2fsck_reconnect_file(e2fsck_t ctx, ino_t inode);