]> git.ipfire.org Git - thirdparty/e2fsprogs.git/blame - e2fsck/e2fsck.h
util.c (ask_yn, read_a_char): Note when the user has typed ^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
54c637d4 30#include "ext2fs/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
3839e657
TT
52/*
53 * Exit codes used by fsck-type programs
54 */
55#define FSCK_OK 0 /* No errors */
56#define FSCK_NONDESTRUCT 1 /* File system errors corrected */
57#define FSCK_REBOOT 2 /* System should be rebooted */
58#define FSCK_UNCORRECTED 4 /* File system errors left uncorrected */
59#define FSCK_ERROR 8 /* Operational error */
60#define FSCK_USAGE 16 /* Usage or syntax error */
4cae0452 61#define FSCK_CANCELED 32 /* Aborted with a signal or ^C */
3839e657
TT
62#define FSCK_LIBRARY 128 /* Shared library error */
63
f3db3566
TT
64/*
65 * The last ext2fs revision level that this version of e2fsck is able to
66 * support
67 */
1e3472c5 68#define E2FSCK_CURRENT_REV 1
f3db3566 69
3839e657
TT
70/*
71 * The directory information structure; stores directory information
72 * collected in earlier passes, to avoid disk i/o in fetching the
21c84b71 73 * directory information.
3839e657
TT
74 */
75struct dir_info {
86c627ec
TT
76 ext2_ino_t ino; /* Inode number */
77 ext2_ino_t dotdot; /* Parent according to '..' */
78 ext2_ino_t parent; /* Parent according to treewalk */
3839e657
TT
79};
80
8fdc9985
TT
81
82/*
83 * The indexed directory information structure; stores information for
84 * directories which contain a hash tree index.
85 */
86struct dx_dir_info {
87 ext2_ino_t ino; /* Inode number */
88 int numblocks; /* number of blocks */
89 int hashversion;
90 struct dx_dirblock_info *dx_block; /* Array of size numblocks */
91};
92
93#define DX_DIRBLOCK_ROOT 1
94#define DX_DIRBLOCK_LEAF 2
95#define DX_DIRBLOCK_NODE 3
96#define DX_DIRBLOCK_CORRUPT 4
97#define DX_DIRBLOCK_CLEARED 8
98
99struct dx_dirblock_info {
100 int type;
101 blk_t phys;
102 int flags;
103 blk_t parent;
104 ext2_dirhash_t min_hash;
105 ext2_dirhash_t max_hash;
106 ext2_dirhash_t node_min_hash;
107 ext2_dirhash_t node_max_hash;
108};
109
110#define DX_FLAG_REFERENCED 1
111#define DX_FLAG_DUP_REF 2
112#define DX_FLAG_FIRST 4
113#define DX_FLAG_LAST 8
114
8bf191e8 115#ifdef RESOURCE_TRACK
3839e657
TT
116/*
117 * This structure is used for keeping track of how much resources have
118 * been used for a particular pass of e2fsck.
119 */
120struct resource_track {
121 struct timeval time_start;
122 struct timeval user_start;
123 struct timeval system_start;
124 void *brk_start;
125};
8bf191e8 126#endif
3839e657
TT
127
128/*
1b6bf175 129 * E2fsck options
3839e657 130 */
1b6bf175
TT
131#define E2F_OPT_READONLY 0x0001
132#define E2F_OPT_PREEN 0x0002
133#define E2F_OPT_YES 0x0004
134#define E2F_OPT_NO 0x0008
135#define E2F_OPT_TIME 0x0010
136#define E2F_OPT_TIME2 0x0020
137#define E2F_OPT_CHECKBLOCKS 0x0040
138#define E2F_OPT_DEBUG 0x0080
d37066a9 139#define E2F_OPT_FORCE 0x0100
3ed57c27 140#define E2F_OPT_WRITECHECK 0x0200
3839e657 141
08b21301
TT
142/*
143 * E2fsck flags
144 */
145#define E2F_FLAG_ABORT 0x0001 /* Abort signaled */
146#define E2F_FLAG_CANCEL 0x0002 /* Cancel signaled */
2df1f6aa 147#define E2F_FLAG_SIGNAL_MASK 0x0003
08b21301 148#define E2F_FLAG_RESTART 0x0004 /* Restart signaled */
08b21301
TT
149
150#define E2F_FLAG_SETJMP_OK 0x0010 /* Setjmp valid for abort */
151
5596defa
TT
152#define E2F_FLAG_PROG_BAR 0x0020 /* Progress bar on screen */
153#define E2F_FLAG_PROG_SUPPRESS 0x0040 /* Progress suspended */
424cd2be 154#define E2F_FLAG_JOURNAL_INODE 0x0080 /* Create a new ext3 journal inode */
ae6cdcf7
TT
155#define E2F_FLAG_SB_SPECIFIED 0x0100 /* The superblock was explicitly
156 * specified by the user */
5596defa 157
08b21301
TT
158/*
159 * Defines for indicating the e2fsck pass number
160 */
161#define E2F_PASS_1 1
162#define E2F_PASS_2 2
163#define E2F_PASS_3 3
164#define E2F_PASS_4 4
165#define E2F_PASS_5 5
166#define E2F_PASS_1B 6
167
342d847d
TT
168/*
169 * Define the extended attribute refcount structure
170 */
171typedef struct ea_refcount *ext2_refcount_t;
172
1b6bf175
TT
173/*
174 * This is the global e2fsck structure.
175 */
08b21301
TT
176typedef struct e2fsck_struct *e2fsck_t;
177
1b6bf175
TT
178struct e2fsck_struct {
179 ext2_filsys fs;
180 const char *program_name;
181 const char *filesystem_name;
182 const char *device_name;
08b21301 183 int flags; /* E2fsck internal flags */
1b6bf175
TT
184 int options;
185 blk_t use_superblock; /* sb requested by user */
186 blk_t superblock; /* sb used to open fs */
f1a1761d 187 int blocksize; /* blocksize */
f8188fff 188 blk_t num_blocks; /* Total number of blocks */
1b6bf175 189
08b21301
TT
190#ifdef HAVE_SETJMP_H
191 jmp_buf abort_loc;
192#endif
f8188fff 193 unsigned long abort_code;
08b21301 194
a02ce9df
TT
195 int (*progress)(e2fsck_t ctx, int pass, unsigned long cur,
196 unsigned long max);
08b21301 197
1b6bf175
TT
198 ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */
199 ext2fs_inode_bitmap inode_bad_map; /* Inodes which are bad somehow */
200 ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */
201 ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */
aa4115a4
TT
202 ext2fs_inode_bitmap inode_imagic_map; /* AFS inodes */
203 ext2fs_inode_bitmap inode_reg_map; /* Inodes which are regular files*/
1b6bf175
TT
204
205 ext2fs_block_bitmap block_found_map; /* Blocks which are in use */
206 ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */
342d847d 207 ext2fs_block_bitmap block_ea_map; /* Blocks which are used by EA's */
1b6bf175
TT
208
209 /*
210 * Inode count arrays
211 */
212 ext2_icount_t inode_count;
213 ext2_icount_t inode_link_info;
214
342d847d
TT
215 ext2_refcount_t refcount;
216 ext2_refcount_t refcount_extra;
217
1b6bf175
TT
218 /*
219 * Array of flags indicating whether an inode bitmap, block
220 * bitmap, or inode table is invalid
221 */
222 int *invalid_inode_bitmap_flag;
223 int *invalid_block_bitmap_flag;
224 int *invalid_inode_table_flag;
225 int invalid_bitmaps; /* There are invalid bitmaps/itable */
226
08b21301
TT
227 /*
228 * Block buffer
229 */
230 char *block_buf;
231
1b6bf175
TT
232 /*
233 * For pass1_check_directory and pass1_get_blocks
234 */
86c627ec 235 ext2_ino_t stashed_ino;
1b6bf175
TT
236 struct ext2_inode *stashed_inode;
237
08b21301
TT
238 /*
239 * Directory information
240 */
241 int dir_info_count;
242 int dir_info_size;
243 struct dir_info *dir_info;
244
8fdc9985
TT
245 /*
246 * Indexed directory information
247 */
248 int dx_dir_info_count;
249 int dx_dir_info_size;
250 struct dx_dir_info *dx_dir_info;
251
b7a00563
TT
252 /*
253 * Directories to hash
254 */
255 ext2_u32_list dirs_to_hash;
256
1b6bf175
TT
257 /*
258 * Tuning parameters
259 */
260 int process_inode_size;
261 int inode_buffer_blocks;
262
adee8d75
TT
263 /*
264 * ext3 journal support
265 */
266 io_channel journal_io;
267 const char *journal_name;
268
8bf191e8 269#ifdef RESOURCE_TRACK
1b6bf175
TT
270 /*
271 * For timing purposes
272 */
273 struct resource_track global_rtrack;
8bf191e8 274#endif
1b6bf175 275
efac9a1b
TT
276 /*
277 * How we display the progress update (for unix)
278 */
279 int progress_fd;
280 int progress_pos;
5596defa 281 int progress_last_percent;
06012323 282 unsigned int progress_last_time;
efac9a1b 283
1b6bf175
TT
284 /* File counts */
285 int fs_directory_count;
286 int fs_regular_count;
287 int fs_blockdev_count;
288 int fs_chardev_count;
289 int fs_links_count;
290 int fs_symlinks_count;
291 int fs_fast_symlinks_count;
292 int fs_fifo_count;
293 int fs_total_count;
294 int fs_badblocks_count;
295 int fs_sockets_count;
296 int fs_ind_count;
297 int fs_dind_count;
298 int fs_tind_count;
299 int fs_fragmented;
246501c6 300 int large_files;
342d847d
TT
301 int fs_ext_attr_inodes;
302 int fs_ext_attr_blocks;
4313932c
TT
303
304 /*
305 * For the use of callers of the e2fsck functions; not used by
306 * e2fsck functions themselves.
307 */
308 void *priv_data;
1b6bf175 309};
f3db3566 310
55fd07ed
TT
311/* Used by the region allocation code */
312typedef __u32 region_addr_t;
313typedef struct region_struct *region_t;
1e3472c5 314
3839e657
TT
315/*
316 * Procedure declarations
317 */
318
08b21301
TT
319extern void e2fsck_pass1(e2fsck_t ctx);
320extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf);
321extern void e2fsck_pass2(e2fsck_t ctx);
322extern void e2fsck_pass3(e2fsck_t ctx);
323extern void e2fsck_pass4(e2fsck_t ctx);
324extern void e2fsck_pass5(e2fsck_t ctx);
1b6bf175
TT
325
326/* e2fsck.c */
08b21301
TT
327extern errcode_t e2fsck_allocate_context(e2fsck_t *ret);
328extern errcode_t e2fsck_reset_context(e2fsck_t ctx);
329extern void e2fsck_free_context(e2fsck_t ctx);
330extern int e2fsck_run(e2fsck_t ctx);
331
3839e657
TT
332
333/* badblock.c */
1b6bf175 334extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
3839e657 335 int replace_bad_blocks);
1b6bf175 336extern void test_disk(e2fsck_t ctx);
3839e657
TT
337
338/* dirinfo.c */
86c627ec
TT
339extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent);
340extern struct dir_info *e2fsck_get_dir_info(e2fsck_t ctx, ext2_ino_t ino);
08b21301 341extern void e2fsck_free_dir_info(e2fsck_t ctx);
f8188fff 342extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
08b21301 343extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx, int *control);
3839e657 344
8fdc9985
TT
345/* dx_dirinfo.c */
346extern void e2fsck_add_dx_dir(e2fsck_t ctx, ext2_ino_t ino, int num_blocks);
347extern struct dx_dir_info *e2fsck_get_dx_dir_info(e2fsck_t ctx, ext2_ino_t ino);
348extern void e2fsck_free_dx_dir_info(e2fsck_t ctx);
349extern int e2fsck_get_num_dx_dirinfo(e2fsck_t ctx);
350extern struct dx_dir_info *e2fsck_dx_dir_info_iter(e2fsck_t ctx, int *control);
351
342d847d
TT
352/* ea_refcount.c */
353extern errcode_t ea_refcount_create(int size, ext2_refcount_t *ret);
354extern void ea_refcount_free(ext2_refcount_t refcount);
355extern errcode_t ea_refcount_fetch(ext2_refcount_t refcount, blk_t blk,
356 int *ret);
357extern errcode_t ea_refcount_increment(ext2_refcount_t refcount,
358 blk_t blk, int *ret);
359extern errcode_t ea_refcount_decrement(ext2_refcount_t refcount,
360 blk_t blk, int *ret);
361extern errcode_t ea_refcount_store(ext2_refcount_t refcount,
362 blk_t blk, int count);
4ea7bd04 363extern blk_t ext2fs_get_refcount_size(ext2_refcount_t refcount);
342d847d
TT
364extern void ea_refcount_intr_begin(ext2_refcount_t refcount);
365extern blk_t ea_refcount_intr_next(ext2_refcount_t refcount, int *ret);
366
3839e657
TT
367/* ehandler.c */
368extern const char *ehandler_operation(const char *op);
369extern void ehandler_init(io_channel channel);
370
17390c04 371/* journal.c */
3b5386dc
TT
372extern int e2fsck_check_ext3_journal(e2fsck_t ctx);
373extern int e2fsck_run_ext3_journal(e2fsck_t ctx);
773fd8a1 374extern void e2fsck_move_ext3_journal(e2fsck_t ctx);
17390c04 375
e72a9ba3
TT
376/* pass1.c */
377extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int bool);
378extern int e2fsck_pass1_check_device_inode(struct ext2_inode *inode);
bcf9c5d4
TT
379extern int e2fsck_pass1_check_symlink(ext2_filsys fs,
380 struct ext2_inode *inode, char *buf);
e72a9ba3
TT
381
382/* pass2.c */
bcf9c5d4
TT
383extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir,
384 ext2_ino_t ino, char *buf);
e72a9ba3
TT
385
386/* pass3.c */
86c627ec 387extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode);
b7a00563
TT
388extern errcode_t e2fsck_expand_directory(e2fsck_t ctx, ext2_ino_t dir,
389 int num, int gauranteed_size);
390
e72a9ba3 391
55fd07ed
TT
392/* region.c */
393extern region_t region_create(region_addr_t min, region_addr_t max);
394extern void region_free(region_t region);
395extern int region_allocate(region_t region, region_addr_t start, int n);
396
b7a00563
TT
397/* rehash.c */
398errcode_t e2fsck_rehash_dir(e2fsck_t ctx, ext2_ino_t ino);
399void e2fsck_rehash_directories(e2fsck_t ctx);
400
1b6bf175
TT
401/* super.c */
402void check_super_block(e2fsck_t ctx);
17dba281 403errcode_t e2fsck_get_device_size(e2fsck_t ctx);
1b6bf175 404
1e3472c5 405/* swapfs.c */
1b6bf175 406void swap_filesys(e2fsck_t ctx);
1e3472c5 407
3839e657 408/* util.c */
f8188fff
TT
409extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
410 const char *description);
1b6bf175 411extern int ask(e2fsck_t ctx, const char * string, int def);
3839e657 412extern int ask_yn(const char * string, int def);
f8188fff
TT
413extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
414extern void e2fsck_read_bitmaps(e2fsck_t ctx);
415extern void e2fsck_write_bitmaps(e2fsck_t ctx);
1b6bf175 416extern void preenhalt(e2fsck_t ctx);
8bf191e8 417#ifdef RESOURCE_TRACK
1b6bf175
TT
418extern void print_resource_track(const char *desc,
419 struct resource_track *track);
3839e657 420extern void init_resource_track(struct resource_track *track);
8bf191e8 421#endif
3839e657 422extern int inode_has_valid_blocks(struct ext2_inode *inode);
08b21301 423extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
f3db3566 424 struct ext2_inode * inode, const char * proc);
08b21301 425extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
f3db3566 426 struct ext2_inode * inode, const char * proc);
3839e657
TT
427#ifdef MTRACE
428extern void mtrace_print(char *mesg);
429#endif
f1a1761d
TT
430extern blk_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs,
431 const char *name, io_manager manager);
6fdc7a32 432extern int ext2_file_type(unsigned int mode);
3839e657 433
5596defa
TT
434/* unix.c */
435extern void e2fsck_clear_progbar(e2fsck_t ctx);