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