]> git.ipfire.org Git - thirdparty/e2fsprogs.git/blame - e2fsck/e2fsck.h
Fix various gcc -Wall nits. Fixed a bug in mke2fs where a bogus
[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 */
61#define FSCK_LIBRARY 128 /* Shared library error */
62
f3db3566
TT
63/*
64 * The last ext2fs revision level that this version of e2fsck is able to
65 * support
66 */
1e3472c5 67#define E2FSCK_CURRENT_REV 1
f3db3566 68
3839e657
TT
69/*
70 * The directory information structure; stores directory information
71 * collected in earlier passes, to avoid disk i/o in fetching the
21c84b71 72 * directory information.
3839e657
TT
73 */
74struct dir_info {
86c627ec
TT
75 ext2_ino_t ino; /* Inode number */
76 ext2_ino_t dotdot; /* Parent according to '..' */
77 ext2_ino_t parent; /* Parent according to treewalk */
3839e657
TT
78};
79
8bf191e8 80#ifdef RESOURCE_TRACK
3839e657
TT
81/*
82 * This structure is used for keeping track of how much resources have
83 * been used for a particular pass of e2fsck.
84 */
85struct resource_track {
86 struct timeval time_start;
87 struct timeval user_start;
88 struct timeval system_start;
89 void *brk_start;
90};
8bf191e8 91#endif
3839e657
TT
92
93/*
1b6bf175 94 * E2fsck options
3839e657 95 */
1b6bf175
TT
96#define E2F_OPT_READONLY 0x0001
97#define E2F_OPT_PREEN 0x0002
98#define E2F_OPT_YES 0x0004
99#define E2F_OPT_NO 0x0008
100#define E2F_OPT_TIME 0x0010
101#define E2F_OPT_TIME2 0x0020
102#define E2F_OPT_CHECKBLOCKS 0x0040
103#define E2F_OPT_DEBUG 0x0080
3839e657 104
08b21301
TT
105/*
106 * E2fsck flags
107 */
108#define E2F_FLAG_ABORT 0x0001 /* Abort signaled */
109#define E2F_FLAG_CANCEL 0x0002 /* Cancel signaled */
2df1f6aa 110#define E2F_FLAG_SIGNAL_MASK 0x0003
08b21301 111#define E2F_FLAG_RESTART 0x0004 /* Restart signaled */
08b21301
TT
112
113#define E2F_FLAG_SETJMP_OK 0x0010 /* Setjmp valid for abort */
114
5596defa
TT
115#define E2F_FLAG_PROG_BAR 0x0020 /* Progress bar on screen */
116#define E2F_FLAG_PROG_SUPPRESS 0x0040 /* Progress suspended */
424cd2be 117#define E2F_FLAG_JOURNAL_INODE 0x0080 /* Create a new ext3 journal inode */
ae6cdcf7
TT
118#define E2F_FLAG_SB_SPECIFIED 0x0100 /* The superblock was explicitly
119 * specified by the user */
5596defa 120
08b21301
TT
121/*
122 * Defines for indicating the e2fsck pass number
123 */
124#define E2F_PASS_1 1
125#define E2F_PASS_2 2
126#define E2F_PASS_3 3
127#define E2F_PASS_4 4
128#define E2F_PASS_5 5
129#define E2F_PASS_1B 6
130
342d847d
TT
131/*
132 * Define the extended attribute refcount structure
133 */
134typedef struct ea_refcount *ext2_refcount_t;
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 */
342d847d 169 ext2fs_block_bitmap block_ea_map; /* Blocks which are used by EA's */
1b6bf175
TT
170
171 /*
172 * Inode count arrays
173 */
174 ext2_icount_t inode_count;
175 ext2_icount_t inode_link_info;
176
342d847d
TT
177 ext2_refcount_t refcount;
178 ext2_refcount_t refcount_extra;
179
1b6bf175
TT
180 /*
181 * Array of flags indicating whether an inode bitmap, block
182 * bitmap, or inode table is invalid
183 */
184 int *invalid_inode_bitmap_flag;
185 int *invalid_block_bitmap_flag;
186 int *invalid_inode_table_flag;
187 int invalid_bitmaps; /* There are invalid bitmaps/itable */
188
08b21301
TT
189 /*
190 * Block buffer
191 */
192 char *block_buf;
193
1b6bf175
TT
194 /*
195 * For pass1_check_directory and pass1_get_blocks
196 */
86c627ec 197 ext2_ino_t stashed_ino;
1b6bf175
TT
198 struct ext2_inode *stashed_inode;
199
08b21301
TT
200 /*
201 * Directory information
202 */
203 int dir_info_count;
204 int dir_info_size;
205 struct dir_info *dir_info;
206
1b6bf175
TT
207 /*
208 * Tuning parameters
209 */
210 int process_inode_size;
211 int inode_buffer_blocks;
212
adee8d75
TT
213 /*
214 * ext3 journal support
215 */
216 io_channel journal_io;
217 const char *journal_name;
218
8bf191e8 219#ifdef RESOURCE_TRACK
1b6bf175
TT
220 /*
221 * For timing purposes
222 */
223 struct resource_track global_rtrack;
8bf191e8 224#endif
1b6bf175 225
efac9a1b
TT
226 /*
227 * How we display the progress update (for unix)
228 */
229 int progress_fd;
230 int progress_pos;
5596defa 231 int progress_last_percent;
06012323 232 unsigned int progress_last_time;
efac9a1b 233
1b6bf175
TT
234 /* File counts */
235 int fs_directory_count;
236 int fs_regular_count;
237 int fs_blockdev_count;
238 int fs_chardev_count;
239 int fs_links_count;
240 int fs_symlinks_count;
241 int fs_fast_symlinks_count;
242 int fs_fifo_count;
243 int fs_total_count;
244 int fs_badblocks_count;
245 int fs_sockets_count;
246 int fs_ind_count;
247 int fs_dind_count;
248 int fs_tind_count;
249 int fs_fragmented;
246501c6 250 int large_files;
342d847d
TT
251 int fs_ext_attr_inodes;
252 int fs_ext_attr_blocks;
4313932c
TT
253
254 /*
255 * For the use of callers of the e2fsck functions; not used by
256 * e2fsck functions themselves.
257 */
258 void *priv_data;
1b6bf175 259};
f3db3566 260
55fd07ed
TT
261/* Used by the region allocation code */
262typedef __u32 region_addr_t;
263typedef struct region_struct *region_t;
1e3472c5 264
3839e657
TT
265/*
266 * Procedure declarations
267 */
268
08b21301
TT
269extern void e2fsck_pass1(e2fsck_t ctx);
270extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf);
271extern void e2fsck_pass2(e2fsck_t ctx);
272extern void e2fsck_pass3(e2fsck_t ctx);
273extern void e2fsck_pass4(e2fsck_t ctx);
274extern void e2fsck_pass5(e2fsck_t ctx);
1b6bf175
TT
275
276/* e2fsck.c */
08b21301
TT
277extern errcode_t e2fsck_allocate_context(e2fsck_t *ret);
278extern errcode_t e2fsck_reset_context(e2fsck_t ctx);
279extern void e2fsck_free_context(e2fsck_t ctx);
280extern int e2fsck_run(e2fsck_t ctx);
281
3839e657
TT
282
283/* badblock.c */
1b6bf175 284extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
3839e657 285 int replace_bad_blocks);
1b6bf175 286extern void test_disk(e2fsck_t ctx);
3839e657
TT
287
288/* dirinfo.c */
86c627ec
TT
289extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent);
290extern struct dir_info *e2fsck_get_dir_info(e2fsck_t ctx, ext2_ino_t ino);
08b21301
TT
291extern void e2fsck_free_dir_info(e2fsck_t ctx);
292extern int e2fsck_get_num_dirs(e2fsck_t ctx);
f8188fff 293extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
08b21301 294extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx, int *control);
3839e657 295
342d847d
TT
296/* ea_refcount.c */
297extern errcode_t ea_refcount_create(int size, ext2_refcount_t *ret);
298extern void ea_refcount_free(ext2_refcount_t refcount);
299extern errcode_t ea_refcount_fetch(ext2_refcount_t refcount, blk_t blk,
300 int *ret);
301extern errcode_t ea_refcount_increment(ext2_refcount_t refcount,
302 blk_t blk, int *ret);
303extern errcode_t ea_refcount_decrement(ext2_refcount_t refcount,
304 blk_t blk, int *ret);
305extern errcode_t ea_refcount_store(ext2_refcount_t refcount,
306 blk_t blk, int count);
4ea7bd04 307extern blk_t ext2fs_get_refcount_size(ext2_refcount_t refcount);
342d847d
TT
308extern void ea_refcount_intr_begin(ext2_refcount_t refcount);
309extern blk_t ea_refcount_intr_next(ext2_refcount_t refcount, int *ret);
310
3839e657
TT
311/* ehandler.c */
312extern const char *ehandler_operation(const char *op);
313extern void ehandler_init(io_channel channel);
314
17390c04 315/* journal.c */
3b5386dc
TT
316extern int e2fsck_check_ext3_journal(e2fsck_t ctx);
317extern int e2fsck_run_ext3_journal(e2fsck_t ctx);
773fd8a1 318extern void e2fsck_move_ext3_journal(e2fsck_t ctx);
17390c04 319
e72a9ba3
TT
320/* pass1.c */
321extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int bool);
322extern int e2fsck_pass1_check_device_inode(struct ext2_inode *inode);
67052a8a 323extern int e2fsck_pass1_check_symlink(ext2_filsys fs, struct ext2_inode *inode);
e72a9ba3
TT
324
325/* pass2.c */
86c627ec 326extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir, ext2_ino_t ino);
e72a9ba3
TT
327
328/* pass3.c */
86c627ec 329extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode);
e72a9ba3 330
55fd07ed
TT
331/* region.c */
332extern region_t region_create(region_addr_t min, region_addr_t max);
333extern void region_free(region_t region);
334extern int region_allocate(region_t region, region_addr_t start, int n);
335
1b6bf175
TT
336/* super.c */
337void check_super_block(e2fsck_t ctx);
17dba281 338errcode_t e2fsck_get_device_size(e2fsck_t ctx);
1b6bf175 339
1e3472c5 340/* swapfs.c */
1b6bf175 341void swap_filesys(e2fsck_t ctx);
1e3472c5 342
3839e657 343/* util.c */
f8188fff
TT
344extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
345 const char *description);
1b6bf175 346extern int ask(e2fsck_t ctx, const char * string, int def);
3839e657 347extern int ask_yn(const char * string, int def);
f8188fff
TT
348extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
349extern void e2fsck_read_bitmaps(e2fsck_t ctx);
350extern void e2fsck_write_bitmaps(e2fsck_t ctx);
1b6bf175 351extern void preenhalt(e2fsck_t ctx);
8bf191e8 352#ifdef RESOURCE_TRACK
1b6bf175
TT
353extern void print_resource_track(const char *desc,
354 struct resource_track *track);
3839e657 355extern void init_resource_track(struct resource_track *track);
8bf191e8 356#endif
3839e657 357extern int inode_has_valid_blocks(struct ext2_inode *inode);
08b21301 358extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
f3db3566 359 struct ext2_inode * inode, const char * proc);
08b21301 360extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
f3db3566 361 struct ext2_inode * inode, const char * proc);
3839e657
TT
362#ifdef MTRACE
363extern void mtrace_print(char *mesg);
364#endif
1b6bf175 365extern blk_t get_backup_sb(ext2_filsys fs);
6fdc7a32 366extern int ext2_file_type(unsigned int mode);
3839e657 367
5596defa
TT
368/* unix.c */
369extern void e2fsck_clear_progbar(e2fsck_t ctx);