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