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