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