e2fsck.h revision 0c37f456d929dac47fcf87374f1c1b9a9a96c9fa 
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#ifndef _E2FSCK_H
10#define _E2FSCK_H
11
12#include <stdio.h>
13#include <string.h>
14#ifdef HAVE_UNISTD_H
15#include <unistd.h>
16#endif
17#include <stdlib.h>
18#include <time.h>
19#ifdef HAVE_SYS_TYPES_H
20#include <sys/types.h>
21#endif
22#ifdef HAVE_SYS_TIME_H
23#include <sys/time.h>
24#endif
25#ifdef HAVE_SETJMP_H
26#include <setjmp.h>
27#endif
28
29#if EXT2_FLAT_INCLUDES
30#include "ext2_fs.h"
31#include "ext2fs.h"
32#include "blkid.h"
33#else
34#include "ext2fs/ext2_fs.h"
35#include "ext2fs/ext2fs.h"
36#include "blkid/blkid.h"
37#endif
38
39#include "profile.h"
40#include "prof_err.h"
41
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
51#define P_(singular, plural, n) (ngettext (singular, plural, n))
52#ifndef NLS_CAT_NAME
53#define NLS_CAT_NAME "e2fsprogs"
54#endif
55#ifndef LOCALEDIR
56#define LOCALEDIR "/usr/share/locale"
57#endif
58#else
59#define _(a) (a)
60#define N_(a) a
61#define P_(singular, plural, n) ((n) == 1 ? (singular) : (plural))
62#endif
63
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 */
73#define FSCK_CANCELED	 32	/* Aborted with a signal or ^C */
74#define FSCK_LIBRARY     128	/* Shared library error */
75
76/*
77 * The last ext2fs revision level that this version of e2fsck is able to
78 * support
79 */
80#define E2FSCK_CURRENT_REV	1
81
82/*
83 * The directory information structure; stores directory information
84 * collected in earlier passes, to avoid disk i/o in fetching the
85 * directory information.
86 */
87struct dir_info {
88	ext2_ino_t		ino;	/* Inode number */
89	ext2_ino_t		dotdot;	/* Parent according to '..' */
90	ext2_ino_t		parent; /* Parent according to treewalk */
91};
92
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;
102	short			depth;		/* depth of tree */
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
128#ifdef RESOURCE_TRACK
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};
139#endif
140
141/*
142 * E2fsck options
143 */
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
152#define E2F_OPT_FORCE		0x0100
153#define E2F_OPT_WRITECHECK	0x0200
154#define E2F_OPT_COMPRESS_DIRS	0x0400
155
156/*
157 * E2fsck flags
158 */
159#define E2F_FLAG_ABORT		0x0001 /* Abort signaled */
160#define E2F_FLAG_CANCEL		0x0002 /* Cancel signaled */
161#define E2F_FLAG_SIGNAL_MASK	0x0003
162#define E2F_FLAG_RESTART	0x0004 /* Restart signaled */
163
164#define E2F_FLAG_SETJMP_OK	0x0010 /* Setjmp valid for abort */
165
166#define E2F_FLAG_PROG_BAR	0x0020 /* Progress bar on screen */
167#define E2F_FLAG_PROG_SUPPRESS	0x0040 /* Progress suspended */
168#define E2F_FLAG_JOURNAL_INODE	0x0080 /* Create a new ext3 journal inode */
169#define E2F_FLAG_SB_SPECIFIED	0x0100 /* The superblock was explicitly
170					* specified by the user */
171#define E2F_FLAG_RESTARTED	0x0200 /* E2fsck has been restarted */
172#define E2F_FLAG_RESIZE_INODE	0x0400 /* Request to recreate resize inode */
173#define E2F_FLAG_GOT_DEVSIZE	0x0800 /* Device size has been fetched */
174
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
185/*
186 * Define the extended attribute refcount structure
187 */
188typedef struct ea_refcount *ext2_refcount_t;
189
190/*
191 * This is the global e2fsck structure.
192 */
193typedef struct e2fsck_struct *e2fsck_t;
194
195struct e2fsck_struct {
196	ext2_filsys fs;
197	const char *program_name;
198	char *filesystem_name;
199	char *device_name;
200	char *io_options;
201	int	flags;		/* E2fsck internal flags */
202	int	options;
203	blk_t	use_superblock;	/* sb requested by user */
204	blk_t	superblock;	/* sb used to open fs */
205	int	blocksize;	/* blocksize */
206	blk_t	num_blocks;	/* Total number of blocks */
207	int	mount_flags;
208	blkid_cache blkid;	/* blkid cache */
209
210#ifdef HAVE_SETJMP_H
211	jmp_buf	abort_loc;
212#endif
213	unsigned long abort_code;
214
215	int (*progress)(e2fsck_t ctx, int pass, unsigned long cur,
216			unsigned long max);
217
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 */
222	ext2fs_inode_bitmap inode_imagic_map; /* AFS inodes */
223	ext2fs_inode_bitmap inode_reg_map; /* Inodes which are regular files*/
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 */
227	ext2fs_block_bitmap block_ea_map; /* Blocks which are used by EA's */
228
229	/*
230	 * Inode count arrays
231	 */
232	ext2_icount_t	inode_count;
233	ext2_icount_t inode_link_info;
234
235	ext2_refcount_t	refcount;
236	ext2_refcount_t refcount_extra;
237
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
247	/*
248	 * Block buffer
249	 */
250	char *block_buf;
251
252	/*
253	 * For pass1_check_directory and pass1_get_blocks
254	 */
255	ext2_ino_t stashed_ino;
256	struct ext2_inode *stashed_inode;
257
258	/*
259	 * Location of the lost and found directory
260	 */
261	ext2_ino_t lost_and_found;
262	int bad_lost_and_found;
263
264	/*
265	 * Directory information
266	 */
267	struct dir_info_db	*dir_info;
268
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
276	/*
277	 * Directories to hash
278	 */
279	ext2_u32_list	dirs_to_hash;
280
281	/*
282	 * Tuning parameters
283	 */
284	int process_inode_size;
285	int inode_buffer_blocks;
286
287	/*
288	 * ext3 journal support
289	 */
290	io_channel	journal_io;
291	char	*journal_name;
292
293#ifdef RESOURCE_TRACK
294	/*
295	 * For timing purposes
296	 */
297	struct resource_track	global_rtrack;
298#endif
299
300	/*
301	 * How we display the progress update (for unix)
302	 */
303	int progress_fd;
304	int progress_pos;
305	int progress_last_percent;
306	unsigned int progress_last_time;
307	int interactive;	/* Are we connected directly to a tty? */
308	char start_meta[2], stop_meta[2];
309
310	/* File counts */
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;
329
330	/* misc fields */
331	time_t now;
332	time_t time_fudge;	/* For working around buggy init scripts */
333	int ext_attr_ver;
334	profile_t	profile;
335	int blocks_per_page;
336
337	/*
338	 * For the use of callers of the e2fsck functions; not used by
339	 * e2fsck functions themselves.
340	 */
341	void *priv_data;
342};
343
344/* Used by the region allocation code */
345typedef __u32 region_addr_t;
346typedef struct region_struct *region_t;
347
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
353/*
354 * Procedure declarations
355 */
356
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);
363
364/* e2fsck.c */
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
370
371/* badblock.c */
372extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
373				 int replace_bad_blocks);
374
375/* dirinfo.c */
376extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent);
377extern void e2fsck_free_dir_info(e2fsck_t ctx);
378extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
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);
391
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
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);
410extern blk_t ext2fs_get_refcount_size(ext2_refcount_t refcount);
411extern void ea_refcount_intr_begin(ext2_refcount_t refcount);
412extern blk_t ea_refcount_intr_next(ext2_refcount_t refcount, int *ret);
413
414/* ehandler.c */
415extern const char *ehandler_operation(const char *op);
416extern void ehandler_init(io_channel channel);
417
418/* journal.c */
419extern int e2fsck_check_ext3_journal(e2fsck_t ctx);
420extern int e2fsck_run_ext3_journal(e2fsck_t ctx);
421extern void e2fsck_move_ext3_journal(e2fsck_t ctx);
422extern int e2fsck_fix_ext3_journal_hint(e2fsck_t ctx);
423
424/* pass1.c */
425extern void e2fsck_setup_tdb_icount(e2fsck_t ctx, int flags,
426				    ext2_icount_t *ret);
427extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int bool);
428extern int e2fsck_pass1_check_device_inode(ext2_filsys fs,
429					   struct ext2_inode *inode);
430extern int e2fsck_pass1_check_symlink(ext2_filsys fs,
431				      struct ext2_inode *inode, char *buf);
432
433/* pass2.c */
434extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir,
435				    ext2_ino_t ino, char *buf);
436
437/* pass3.c */
438extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode);
439extern errcode_t e2fsck_expand_directory(e2fsck_t ctx, ext2_ino_t dir,
440					 int num, int gauranteed_size);
441extern ext2_ino_t e2fsck_get_lost_and_found(e2fsck_t ctx, int fix);
442extern errcode_t e2fsck_adjust_inode_count(e2fsck_t ctx, ext2_ino_t ino,
443					   int adj);
444
445
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
451/* rehash.c */
452errcode_t e2fsck_rehash_dir(e2fsck_t ctx, ext2_ino_t ino);
453void e2fsck_rehash_directories(e2fsck_t ctx);
454
455/* super.c */
456void check_super_block(e2fsck_t ctx);
457int check_backup_super_block(e2fsck_t ctx);
458
459/* swapfs.c */
460void swap_filesys(e2fsck_t ctx);
461
462/* util.c */
463extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
464				    const char *description);
465extern int ask(e2fsck_t ctx, const char * string, int def);
466extern int ask_yn(const char * string, int def);
467extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
468extern void e2fsck_read_bitmaps(e2fsck_t ctx);
469extern void e2fsck_write_bitmaps(e2fsck_t ctx);
470extern void preenhalt(e2fsck_t ctx);
471extern char *string_copy(e2fsck_t ctx, const char *str, int len);
472#ifdef RESOURCE_TRACK
473extern void print_resource_track(const char *desc,
474				 struct resource_track *track);
475extern void init_resource_track(struct resource_track *track);
476#endif
477extern int inode_has_valid_blocks(struct ext2_inode *inode);
478extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
479			      struct ext2_inode * inode, const char * proc);
480extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
481			       struct ext2_inode * inode, const char * proc);
482extern void e2fsck_write_inode_full(e2fsck_t ctx, unsigned long ino,
483                               struct ext2_inode * inode, int bufsize,
484                               const char *proc);
485#ifdef MTRACE
486extern void mtrace_print(char *mesg);
487#endif
488extern blk_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs,
489			   const char *name, io_manager manager);
490extern int ext2_file_type(unsigned int mode);
491
492/* unix.c */
493extern void e2fsck_clear_progbar(e2fsck_t ctx);
494extern int e2fsck_simple_progress(e2fsck_t ctx, const char *label,
495				  float percent, unsigned int dpynum);
496#endif /* _E2FSCK_H */
497