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