[thirdparty/e2fsprogs.git] / e2fsck / e2fsck.h

/*
 * e2fsck.h
 * 
 * Copyright (C) 1993, 1994 Theodore Ts'o.  This file may be
 * redistributed under the terms of the GNU Public License.
 * 
 */

#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <stdlib.h>
#include <time.h>
#ifdef HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
#ifdef HAVE_SETJMP_H
#include <setjmp.h>
#endif

#ifdef HAVE_LINUX_FS_H
#include <linux/fs.h>
#endif

#if EXT2_FLAT_INCLUDES
#include "ext2_fs.h"
#include "ext2fs.h"
#else
#include <linux/ext2_fs.h>
#include "ext2fs/ext2fs.h"
#endif


/* Everything is STDC, these days */
#define NOARGS void

/*
 * Exit codes used by fsck-type programs
 */
#define FSCK_OK          0	/* No errors */
#define FSCK_NONDESTRUCT 1	/* File system errors corrected */
#define FSCK_REBOOT      2	/* System should be rebooted */
#define FSCK_UNCORRECTED 4	/* File system errors left uncorrected */
#define FSCK_ERROR       8	/* Operational error */
#define FSCK_USAGE       16	/* Usage or syntax error */
#define FSCK_LIBRARY     128	/* Shared library error */

/*
 * The last ext2fs revision level that this version of e2fsck is able to
 * support
 */
#define E2FSCK_CURRENT_REV	1

/*
 * The directory information structure; stores directory information
 * collected in earlier passes, to avoid disk i/o in fetching the
 * directory information.
 */
struct dir_info {
	ino_t			ino;	/* Inode number */
	ino_t			dotdot;	/* Parent according to '..' */
	ino_t			parent; /* Parent according to treewalk */
};

#ifdef RESOURCE_TRACK
/*
 * This structure is used for keeping track of how much resources have
 * been used for a particular pass of e2fsck.
 */
struct resource_track {
	struct timeval time_start;
	struct timeval user_start;
	struct timeval system_start;
	void	*brk_start;
};
#endif

/*
 * E2fsck options
 */
#define E2F_OPT_READONLY	0x0001
#define E2F_OPT_PREEN		0x0002
#define E2F_OPT_YES		0x0004
#define E2F_OPT_NO		0x0008
#define E2F_OPT_TIME		0x0010
#define E2F_OPT_TIME2		0x0020
#define E2F_OPT_CHECKBLOCKS	0x0040
#define E2F_OPT_DEBUG		0x0080

/*
 * E2fsck flags
 */
#define E2F_FLAG_ABORT		0x0001 /* Abort signaled */
#define E2F_FLAG_CANCEL		0x0002 /* Cancel signaled */
#define E2F_FLAG_RESTART	0x0004 /* Restart signaled */
#define E2F_FLAG_SIGNAL_MASK	0x000F

#define E2F_FLAG_SETJMP_OK	0x0010 /* Setjmp valid for abort */

/*
 * Defines for indicating the e2fsck pass number
 */
#define E2F_PASS_1	1
#define E2F_PASS_2	2
#define E2F_PASS_3	3
#define E2F_PASS_4	4
#define E2F_PASS_5	5
#define E2F_PASS_1B	6

/*
 * This is the global e2fsck structure.
 */
typedef struct e2fsck_struct *e2fsck_t;

struct e2fsck_struct {
	ext2_filsys fs;
	const char *program_name;
	const char *filesystem_name;
	const char *device_name;
	int	flags;		/* E2fsck internal flags */
	int	options;
	blk_t	use_superblock;	/* sb requested by user */
	blk_t	superblock;	/* sb used to open fs */
	blk_t	num_blocks;	/* Total number of blocks */

#ifdef HAVE_SETJMP_H
	jmp_buf	abort_loc;
#endif
	unsigned long abort_code;

	int (*progress)(e2fsck_t ctx, int pass, unsigned long cur,
			unsigned long max);

	ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */
	ext2fs_inode_bitmap inode_bad_map; /* Inodes which are bad somehow */
	ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */
	ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */

	ext2fs_block_bitmap block_found_map; /* Blocks which are in use */
	ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */
	ext2fs_block_bitmap block_illegal_map; /* Meta-data blocks */

	/*
	 * Inode count arrays
	 */
	ext2_icount_t	inode_count;
	ext2_icount_t inode_link_info;

	/*
	 * Array of flags indicating whether an inode bitmap, block
	 * bitmap, or inode table is invalid
	 */
	int *invalid_inode_bitmap_flag;
	int *invalid_block_bitmap_flag;
	int *invalid_inode_table_flag;
	int invalid_bitmaps;	/* There are invalid bitmaps/itable */

	/*
	 * Block buffer
	 */
	char *block_buf;

	/*
	 * For pass1_check_directory and pass1_get_blocks
	 */
	ino_t stashed_ino;
	struct ext2_inode *stashed_inode;

	/*
	 * Directory information
	 */
	int		dir_info_count;
	int		dir_info_size;
	struct dir_info	*dir_info;

	/*
	 * Tuning parameters
	 */
	int process_inode_size;
	int inode_buffer_blocks;

#ifdef RESOURCE_TRACK
	/*
	 * For timing purposes
	 */
	struct resource_track	global_rtrack;
#endif

	/* File counts */
	int fs_directory_count;
	int fs_regular_count;
	int fs_blockdev_count;
	int fs_chardev_count;
	int fs_links_count;
	int fs_symlinks_count;
	int fs_fast_symlinks_count;
	int fs_fifo_count;
	int fs_total_count;
	int fs_badblocks_count;
	int fs_sockets_count;
	int fs_ind_count;
	int fs_dind_count;
	int fs_tind_count;
	int fs_fragmented;

	/*
	 * For the use of callers of the e2fsck functions; not used by
	 * e2fsck functions themselves.
	 */
	void *priv_data;
};


/*
 * Procedure declarations
 */

extern void e2fsck_pass1(e2fsck_t ctx);
extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf);
extern void e2fsck_pass2(e2fsck_t ctx);
extern void e2fsck_pass3(e2fsck_t ctx);
extern void e2fsck_pass4(e2fsck_t ctx);
extern void e2fsck_pass5(e2fsck_t ctx);

/* e2fsck.c */
extern errcode_t e2fsck_allocate_context(e2fsck_t *ret);
extern errcode_t e2fsck_reset_context(e2fsck_t ctx);
extern void e2fsck_free_context(e2fsck_t ctx);
extern int e2fsck_run(e2fsck_t ctx);


/* pass1.c */
extern errcode_t pass1_check_directory(ext2_filsys fs, ino_t ino);
extern errcode_t pass1_get_blocks(ext2_filsys fs, ino_t ino, blk_t *blocks);
extern errcode_t pass1_read_inode(ext2_filsys fs, ino_t ino,
				  struct ext2_inode *inode);
extern errcode_t pass1_write_inode(ext2_filsys fs, ino_t ino,
				   struct ext2_inode *inode);
extern int e2fsck_pass1_check_device_inode(struct ext2_inode *inode);

/* badblock.c */
extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
				 int replace_bad_blocks);
extern void test_disk(e2fsck_t ctx);

/* dirinfo.c */
extern void e2fsck_add_dir_info(e2fsck_t ctx, ino_t ino, ino_t parent);
extern struct dir_info *e2fsck_get_dir_info(e2fsck_t ctx, ino_t ino);
extern void e2fsck_free_dir_info(e2fsck_t ctx);
extern int e2fsck_get_num_dirs(e2fsck_t ctx);
extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx, int *control);

/* ehandler.c */
extern const char *ehandler_operation(const char *op);
extern void ehandler_init(io_channel channel);

/* super.c */
void check_super_block(e2fsck_t ctx);

/* swapfs.c */
void swap_filesys(e2fsck_t ctx);

/* util.c */
extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
				    const char *description);
extern int ask(e2fsck_t ctx, const char * string, int def);
extern int ask_yn(const char * string, int def);
extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
extern void e2fsck_read_bitmaps(e2fsck_t ctx);
extern void e2fsck_write_bitmaps(e2fsck_t ctx);
extern void preenhalt(e2fsck_t ctx);
#ifdef RESOURCE_TRACK
extern void print_resource_track(const char *desc,
				 struct resource_track *track);
extern void init_resource_track(struct resource_track *track);
#endif
extern int inode_has_valid_blocks(struct ext2_inode *inode);
extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
			      struct ext2_inode * inode, const char * proc);
extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
			       struct ext2_inode * inode, const char * proc);
#ifdef MTRACE
extern void mtrace_print(char *mesg);
#endif
extern blk_t get_backup_sb(ext2_filsys fs);

/*
 * pass3.c
 */
extern int e2fsck_reconnect_file(e2fsck_t ctx, ino_t inode);
Commit	Line	Data
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>
	11	#include <unistd.h>
	12	#include <stdlib.h>
54be2ccc	13	#include <time.h>
b2da22d1	14	#ifdef HAVE_SYS_TYPES_H
3839e657	15	#include <sys/types.h>
b2da22d1 TT	16	#endif
b2da22d1 TT	17	#ifdef HAVE_SYS_TIME_H
3839e657	18	#include <sys/time.h>
b2da22d1	19	#endif
08b21301 TT	20	#ifdef HAVE_SETJMP_H
	21	#include <setjmp.h>
	22	#endif
3839e657	23
50e1e10f	24	#ifdef HAVE_LINUX_FS_H
3839e657	25	#include <linux/fs.h>
50e1e10f	26	#endif
3839e657	27
54dc7ca2 TT	28	#if EXT2_FLAT_INCLUDES
	29	#include "ext2_fs.h"
	30	#include "ext2fs.h"
	31	#else
	32	#include <linux/ext2_fs.h>
3839e657	33	#include "ext2fs/ext2fs.h"
54dc7ca2 TT	34	#endif
54dc7ca2 TT	35
3839e657	36
08b21301	37	/* Everything is STDC, these days */
3839e657	38	#define NOARGS void
3839e657 TT	39
	40	/*
	41	* Exit codes used by fsck-type programs
	42	*/
	43	#define FSCK_OK 0 /* No errors */
	44	#define FSCK_NONDESTRUCT 1 /* File system errors corrected */
	45	#define FSCK_REBOOT 2 /* System should be rebooted */
	46	#define FSCK_UNCORRECTED 4 /* File system errors left uncorrected */
	47	#define FSCK_ERROR 8 /* Operational error */
	48	#define FSCK_USAGE 16 /* Usage or syntax error */
	49	#define FSCK_LIBRARY 128 /* Shared library error */
	50
f3db3566 TT	51	/*
	52	* The last ext2fs revision level that this version of e2fsck is able to
	53	* support
	54	*/
1e3472c5	55	#define E2FSCK_CURRENT_REV 1
f3db3566	56
3839e657 TT	57	/*
	58	* The directory information structure; stores directory information
	59	* collected in earlier passes, to avoid disk i/o in fetching the
21c84b71	60	* directory information.
3839e657 TT	61	*/
	62	struct dir_info {
	63	ino_t ino; /* Inode number */
	64	ino_t dotdot; /* Parent according to '..' */
	65	ino_t parent; /* Parent according to treewalk */
	66	};
	67
8bf191e8	68	#ifdef RESOURCE_TRACK
3839e657 TT	69	/*
	70	* This structure is used for keeping track of how much resources have
	71	* been used for a particular pass of e2fsck.
	72	*/
	73	struct resource_track {
	74	struct timeval time_start;
	75	struct timeval user_start;
	76	struct timeval system_start;
	77	void *brk_start;
	78	};
8bf191e8	79	#endif
3839e657 TT	80
3839e657 TT	81	/*
1b6bf175	82	* E2fsck options
3839e657	83	*/
1b6bf175 TT	84	#define E2F_OPT_READONLY 0x0001
	85	#define E2F_OPT_PREEN 0x0002
	86	#define E2F_OPT_YES 0x0004
	87	#define E2F_OPT_NO 0x0008
	88	#define E2F_OPT_TIME 0x0010
	89	#define E2F_OPT_TIME2 0x0020
	90	#define E2F_OPT_CHECKBLOCKS 0x0040
	91	#define E2F_OPT_DEBUG 0x0080
3839e657	92
08b21301 TT	93	/*
	94	* E2fsck flags
	95	*/
	96	#define E2F_FLAG_ABORT 0x0001 /* Abort signaled */
	97	#define E2F_FLAG_CANCEL 0x0002 /* Cancel signaled */
	98	#define E2F_FLAG_RESTART 0x0004 /* Restart signaled */
	99	#define E2F_FLAG_SIGNAL_MASK 0x000F
	100
	101	#define E2F_FLAG_SETJMP_OK 0x0010 /* Setjmp valid for abort */
	102
	103	/*
	104	* Defines for indicating the e2fsck pass number
	105	*/
	106	#define E2F_PASS_1 1
	107	#define E2F_PASS_2 2
	108	#define E2F_PASS_3 3
	109	#define E2F_PASS_4 4
	110	#define E2F_PASS_5 5
	111	#define E2F_PASS_1B 6
	112
1b6bf175 TT	113	/*
	114	* This is the global e2fsck structure.
	115	*/
08b21301 TT	116	typedef struct e2fsck_struct *e2fsck_t;
08b21301 TT	117
1b6bf175 TT	118	struct e2fsck_struct {
	119	ext2_filsys fs;
	120	const char *program_name;
	121	const char *filesystem_name;
	122	const char *device_name;
08b21301	123	int flags; /* E2fsck internal flags */
1b6bf175 TT	124	int options;
	125	blk_t use_superblock; /* sb requested by user */
	126	blk_t superblock; /* sb used to open fs */
f8188fff	127	blk_t num_blocks; /* Total number of blocks */
1b6bf175	128
08b21301 TT	129	#ifdef HAVE_SETJMP_H
	130	jmp_buf abort_loc;
	131	#endif
f8188fff	132	unsigned long abort_code;
08b21301	133
a02ce9df TT	134	int (*progress)(e2fsck_t ctx, int pass, unsigned long cur,
a02ce9df TT	135	unsigned long max);
08b21301	136
1b6bf175 TT	137	ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */
	138	ext2fs_inode_bitmap inode_bad_map; /* Inodes which are bad somehow */
	139	ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */
	140	ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */
	141
	142	ext2fs_block_bitmap block_found_map; /* Blocks which are in use */
	143	ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */
	144	ext2fs_block_bitmap block_illegal_map; /* Meta-data blocks */
	145
	146	/*
	147	* Inode count arrays
	148	*/
	149	ext2_icount_t inode_count;
	150	ext2_icount_t inode_link_info;
	151
	152	/*
	153	* Array of flags indicating whether an inode bitmap, block
	154	* bitmap, or inode table is invalid
	155	*/
	156	int *invalid_inode_bitmap_flag;
	157	int *invalid_block_bitmap_flag;
	158	int *invalid_inode_table_flag;
	159	int invalid_bitmaps; /* There are invalid bitmaps/itable */
	160
08b21301 TT	161	/*
	162	* Block buffer
	163	*/
	164	char *block_buf;
	165
1b6bf175 TT	166	/*
	167	* For pass1_check_directory and pass1_get_blocks
	168	*/
	169	ino_t stashed_ino;
	170	struct ext2_inode *stashed_inode;
	171
08b21301 TT	172	/*
	173	* Directory information
	174	*/
	175	int dir_info_count;
	176	int dir_info_size;
	177	struct dir_info *dir_info;
	178
1b6bf175 TT	179	/*
	180	* Tuning parameters
	181	*/
	182	int process_inode_size;
	183	int inode_buffer_blocks;
	184
8bf191e8	185	#ifdef RESOURCE_TRACK
1b6bf175 TT	186	/*
	187	* For timing purposes
	188	*/
	189	struct resource_track global_rtrack;
8bf191e8	190	#endif
1b6bf175 TT	191
	192	/* File counts */
	193	int fs_directory_count;
	194	int fs_regular_count;
	195	int fs_blockdev_count;
	196	int fs_chardev_count;
	197	int fs_links_count;
	198	int fs_symlinks_count;
	199	int fs_fast_symlinks_count;
	200	int fs_fifo_count;
	201	int fs_total_count;
	202	int fs_badblocks_count;
	203	int fs_sockets_count;
	204	int fs_ind_count;
	205	int fs_dind_count;
	206	int fs_tind_count;
	207	int fs_fragmented;
4313932c TT	208
	209	/*
	210	* For the use of callers of the e2fsck functions; not used by
	211	* e2fsck functions themselves.
	212	*/
	213	void *priv_data;
1b6bf175	214	};
f3db3566	215
1e3472c5	216
3839e657 TT	217	/*
	218	* Procedure declarations
	219	*/
	220
08b21301 TT	221	extern void e2fsck_pass1(e2fsck_t ctx);
	222	extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf);
	223	extern void e2fsck_pass2(e2fsck_t ctx);
	224	extern void e2fsck_pass3(e2fsck_t ctx);
	225	extern void e2fsck_pass4(e2fsck_t ctx);
	226	extern void e2fsck_pass5(e2fsck_t ctx);
1b6bf175 TT	227
1b6bf175 TT	228	/* e2fsck.c */
08b21301 TT	229	extern errcode_t e2fsck_allocate_context(e2fsck_t *ret);
	230	extern errcode_t e2fsck_reset_context(e2fsck_t ctx);
	231	extern void e2fsck_free_context(e2fsck_t ctx);
	232	extern int e2fsck_run(e2fsck_t ctx);
	233
3839e657	234
1e3472c5 TT	235	/* pass1.c */
	236	extern errcode_t pass1_check_directory(ext2_filsys fs, ino_t ino);
	237	extern errcode_t pass1_get_blocks(ext2_filsys fs, ino_t ino, blk_t *blocks);
	238	extern errcode_t pass1_read_inode(ext2_filsys fs, ino_t ino,
	239	struct ext2_inode *inode);
	240	extern errcode_t pass1_write_inode(ext2_filsys fs, ino_t ino,
	241	struct ext2_inode *inode);
7cf73dcd	242	extern int e2fsck_pass1_check_device_inode(struct ext2_inode *inode);
1e3472c5	243
3839e657	244	/* badblock.c */
1b6bf175	245	extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
3839e657	246	int replace_bad_blocks);
1b6bf175	247	extern void test_disk(e2fsck_t ctx);
3839e657 TT	248
3839e657 TT	249	/* dirinfo.c */
08b21301 TT	250	extern void e2fsck_add_dir_info(e2fsck_t ctx, ino_t ino, ino_t parent);
	251	extern struct dir_info *e2fsck_get_dir_info(e2fsck_t ctx, ino_t ino);
	252	extern void e2fsck_free_dir_info(e2fsck_t ctx);
	253	extern int e2fsck_get_num_dirs(e2fsck_t ctx);
f8188fff	254	extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
08b21301	255	extern struct dir_info e2fsck_dir_info_iter(e2fsck_t ctx, int control);
3839e657 TT	256
	257	/* ehandler.c */
	258	extern const char ehandler_operation(const char op);
	259	extern void ehandler_init(io_channel channel);
	260
1b6bf175 TT	261	/* super.c */
	262	void check_super_block(e2fsck_t ctx);
	263
1e3472c5	264	/* swapfs.c */
1b6bf175	265	void swap_filesys(e2fsck_t ctx);
1e3472c5	266
3839e657	267	/* util.c */
f8188fff TT	268	extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
f8188fff TT	269	const char *description);
1b6bf175	270	extern int ask(e2fsck_t ctx, const char * string, int def);
3839e657	271	extern int ask_yn(const char * string, int def);
f8188fff TT	272	extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
	273	extern void e2fsck_read_bitmaps(e2fsck_t ctx);
	274	extern void e2fsck_write_bitmaps(e2fsck_t ctx);
1b6bf175	275	extern void preenhalt(e2fsck_t ctx);
8bf191e8	276	#ifdef RESOURCE_TRACK
1b6bf175 TT	277	extern void print_resource_track(const char *desc,
1b6bf175 TT	278	struct resource_track *track);
3839e657	279	extern void init_resource_track(struct resource_track *track);
8bf191e8	280	#endif
3839e657	281	extern int inode_has_valid_blocks(struct ext2_inode *inode);
08b21301	282	extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
f3db3566	283	struct ext2_inode * inode, const char * proc);
08b21301	284	extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
f3db3566	285	struct ext2_inode * inode, const char * proc);
3839e657 TT	286	#ifdef MTRACE
	287	extern void mtrace_print(char *mesg);
	288	#endif
1b6bf175	289	extern blk_t get_backup_sb(ext2_filsys fs);
3839e657	290
3839e657 TT	291	/*
	292	* pass3.c
	293	*/
08b21301	294	extern int e2fsck_reconnect_file(e2fsck_t ctx, ino_t inode);