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