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	unsigned long long bytes_read;
139	unsigned long long bytes_written;
140};
141#endif
142
143/*
144 * E2fsck options
145 */
146#define E2F_OPT_READONLY	0x0001
147#define E2F_OPT_PREEN		0x0002
148#define E2F_OPT_YES		0x0004
149#define E2F_OPT_NO		0x0008
150#define E2F_OPT_TIME		0x0010
151#define E2F_OPT_TIME2		0x0020
152#define E2F_OPT_CHECKBLOCKS	0x0040
153#define E2F_OPT_DEBUG		0x0080
154#define E2F_OPT_FORCE		0x0100
155#define E2F_OPT_WRITECHECK	0x0200
156#define E2F_OPT_COMPRESS_DIRS	0x0400
157#define E2F_OPT_FRAGCHECK	0x0800
158#define E2F_OPT_JOURNAL_ONLY	0x1000 /* only replay the journal */
159
160/*
161 * E2fsck flags
162 */
163#define E2F_FLAG_ABORT		0x0001 /* Abort signaled */
164#define E2F_FLAG_CANCEL		0x0002 /* Cancel signaled */
165#define E2F_FLAG_SIGNAL_MASK	0x0003
166#define E2F_FLAG_RESTART	0x0004 /* Restart signaled */
167#define E2F_FLAG_RESTART_LATER	0x0008 /* Restart after all iterations done */
168
169#define E2F_FLAG_SETJMP_OK	0x0010 /* Setjmp valid for abort */
170
171#define E2F_FLAG_PROG_BAR	0x0020 /* Progress bar on screen */
172#define E2F_FLAG_PROG_SUPPRESS	0x0040 /* Progress suspended */
173#define E2F_FLAG_JOURNAL_INODE	0x0080 /* Create a new ext3 journal inode */
174#define E2F_FLAG_SB_SPECIFIED	0x0100 /* The superblock was explicitly
175					* specified by the user */
176#define E2F_FLAG_RESTARTED	0x0200 /* E2fsck has been restarted */
177#define E2F_FLAG_RESIZE_INODE	0x0400 /* Request to recreate resize inode */
178#define E2F_FLAG_GOT_DEVSIZE	0x0800 /* Device size has been fetched */
179#define E2F_FLAG_EXITING	0x1000 /* E2fsck exiting due to errors */
180#define E2F_FLAG_TIME_INSANE	0x2000 /* Time is insane */
181
182#define E2F_RESET_FLAGS (E2F_FLAG_TIME_INSANE)
183
184/*
185 * Defines for indicating the e2fsck pass number
186 */
187#define E2F_PASS_1	1
188#define E2F_PASS_2	2
189#define E2F_PASS_3	3
190#define E2F_PASS_4	4
191#define E2F_PASS_5	5
192#define E2F_PASS_1B	6
193
194/*
195 * Define the extended attribute refcount structure
196 */
197typedef struct ea_refcount *ext2_refcount_t;
198
199/*
200 * This is the global e2fsck structure.
201 */
202typedef struct e2fsck_struct *e2fsck_t;
203
204#define MAX_EXTENT_DEPTH_COUNT 5
205
206struct e2fsck_struct {
207	ext2_filsys fs;
208	const char *program_name;
209	char *filesystem_name;
210	char *device_name;
211	char *io_options;
212	int	flags;		/* E2fsck internal flags */
213	int	options;
214	blk_t	use_superblock;	/* sb requested by user */
215	blk_t	superblock;	/* sb used to open fs */
216	int	blocksize;	/* blocksize */
217	blk64_t	num_blocks;	/* Total number of blocks */
218	int	mount_flags;
219	blkid_cache blkid;	/* blkid cache */
220
221#ifdef HAVE_SETJMP_H
222	jmp_buf	abort_loc;
223#endif
224	unsigned long abort_code;
225
226	int (*progress)(e2fsck_t ctx, int pass, unsigned long cur,
227			unsigned long max);
228
229	ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */
230	ext2fs_inode_bitmap inode_bad_map; /* Inodes which are bad somehow */
231	ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */
232	ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */
233	ext2fs_inode_bitmap inode_imagic_map; /* AFS inodes */
234	ext2fs_inode_bitmap inode_reg_map; /* Inodes which are regular files*/
235
236	ext2fs_block_bitmap block_found_map; /* Blocks which are in use */
237	ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */
238	ext2fs_block_bitmap block_ea_map; /* Blocks which are used by EA's */
239
240	/*
241	 * Inode count arrays
242	 */
243	ext2_icount_t	inode_count;
244	ext2_icount_t inode_link_info;
245
246	ext2_refcount_t	refcount;
247	ext2_refcount_t refcount_extra;
248
249	/*
250	 * Array of flags indicating whether an inode bitmap, block
251	 * bitmap, or inode table is invalid
252	 */
253	int *invalid_inode_bitmap_flag;
254	int *invalid_block_bitmap_flag;
255	int *invalid_inode_table_flag;
256	int invalid_bitmaps;	/* There are invalid bitmaps/itable */
257
258	/*
259	 * Block buffer
260	 */
261	char *block_buf;
262
263	/*
264	 * For pass1_check_directory and pass1_get_blocks
265	 */
266	ext2_ino_t stashed_ino;
267	struct ext2_inode *stashed_inode;
268
269	/*
270	 * Location of the lost and found directory
271	 */
272	ext2_ino_t lost_and_found;
273	int bad_lost_and_found;
274
275	/*
276	 * Directory information
277	 */
278	struct dir_info_db	*dir_info;
279
280	/*
281	 * Indexed directory information
282	 */
283	int		dx_dir_info_count;
284	int		dx_dir_info_size;
285	struct dx_dir_info *dx_dir_info;
286
287	/*
288	 * Directories to hash
289	 */
290	ext2_u32_list	dirs_to_hash;
291
292	/*
293	 * Tuning parameters
294	 */
295	int process_inode_size;
296	int inode_buffer_blocks;
297	unsigned int htree_slack_percentage;
298
299	/*
300	 * ext3 journal support
301	 */
302	io_channel	journal_io;
303	char	*journal_name;
304
305#ifdef RESOURCE_TRACK
306	/*
307	 * For timing purposes
308	 */
309	struct resource_track	global_rtrack;
310#endif
311
312	/*
313	 * How we display the progress update (for unix)
314	 */
315	int progress_fd;
316	int progress_pos;
317	int progress_last_percent;
318	unsigned int progress_last_time;
319	int interactive;	/* Are we connected directly to a tty? */
320	char start_meta[2], stop_meta[2];
321
322	/* File counts */
323	__u32 fs_directory_count;
324	__u32 fs_regular_count;
325	__u32 fs_blockdev_count;
326	__u32 fs_chardev_count;
327	__u32 fs_links_count;
328	__u32 fs_symlinks_count;
329	__u32 fs_fast_symlinks_count;
330	__u32 fs_fifo_count;
331	__u32 fs_total_count;
332	__u32 fs_badblocks_count;
333	__u32 fs_sockets_count;
334	__u32 fs_ind_count;
335	__u32 fs_dind_count;
336	__u32 fs_tind_count;
337	__u32 fs_fragmented;
338	__u32 fs_fragmented_dir;
339	__u32 large_files;
340	__u32 fs_ext_attr_inodes;
341	__u32 fs_ext_attr_blocks;
342	__u32 extent_depth_count[MAX_EXTENT_DEPTH_COUNT];
343
344	/* misc fields */
345	time_t now;
346	time_t time_fudge;	/* For working around buggy init scripts */
347	int ext_attr_ver;
348	profile_t	profile;
349	int blocks_per_page;
350
351	/*
352	 * For the use of callers of the e2fsck functions; not used by
353	 * e2fsck functions themselves.
354	 */
355	void *priv_data;
356};
357
358/* Used by the region allocation code */
359typedef __u32 region_addr_t;
360typedef struct region_struct *region_t;
361
362#ifndef HAVE_STRNLEN
363#define strnlen(str, x) e2fsck_strnlen((str),(x))
364extern int e2fsck_strnlen(const char * s, int count);
365#endif
366
367/*
368 * Procedure declarations
369 */
370
371extern void e2fsck_pass1(e2fsck_t ctx);
372extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf);
373extern void e2fsck_pass2(e2fsck_t ctx);
374extern void e2fsck_pass3(e2fsck_t ctx);
375extern void e2fsck_pass4(e2fsck_t ctx);
376extern void e2fsck_pass5(e2fsck_t ctx);
377
378/* e2fsck.c */
379extern errcode_t e2fsck_allocate_context(e2fsck_t *ret);
380extern errcode_t e2fsck_reset_context(e2fsck_t ctx);
381extern void e2fsck_free_context(e2fsck_t ctx);
382extern int e2fsck_run(e2fsck_t ctx);
383
384
385/* badblock.c */
386extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
387				 int replace_bad_blocks);
388
389/* crc32.c */
390extern __u32 crc32_be(__u32 crc, unsigned char const *p, size_t len);
391
392/* dirinfo.c */
393extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent);
394extern void e2fsck_free_dir_info(e2fsck_t ctx);
395extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
396extern struct dir_info_iter *e2fsck_dir_info_iter_begin(e2fsck_t ctx);
397extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx,
398					     struct dir_info_iter *);
399extern void e2fsck_dir_info_iter_end(e2fsck_t ctx, struct dir_info_iter *);
400extern int e2fsck_dir_info_set_parent(e2fsck_t ctx, ext2_ino_t ino,
401				      ext2_ino_t parent);
402extern int e2fsck_dir_info_set_dotdot(e2fsck_t ctx, ext2_ino_t ino,
403				      ext2_ino_t dotdot);
404extern int e2fsck_dir_info_get_parent(e2fsck_t ctx, ext2_ino_t ino,
405				      ext2_ino_t *parent);
406extern int e2fsck_dir_info_get_dotdot(e2fsck_t ctx, ext2_ino_t ino,
407				      ext2_ino_t *dotdot);
408
409/* dx_dirinfo.c */
410extern void e2fsck_add_dx_dir(e2fsck_t ctx, ext2_ino_t ino, int num_blocks);
411extern struct dx_dir_info *e2fsck_get_dx_dir_info(e2fsck_t ctx, ext2_ino_t ino);
412extern void e2fsck_free_dx_dir_info(e2fsck_t ctx);
413extern int e2fsck_get_num_dx_dirinfo(e2fsck_t ctx);
414extern struct dx_dir_info *e2fsck_dx_dir_info_iter(e2fsck_t ctx, int *control);
415
416/* ea_refcount.c */
417extern errcode_t ea_refcount_create(int size, ext2_refcount_t *ret);
418extern void ea_refcount_free(ext2_refcount_t refcount);
419extern errcode_t ea_refcount_fetch(ext2_refcount_t refcount, blk_t blk,
420				   int *ret);
421extern errcode_t ea_refcount_increment(ext2_refcount_t refcount,
422				       blk_t blk, int *ret);
423extern errcode_t ea_refcount_decrement(ext2_refcount_t refcount,
424				       blk_t blk, int *ret);
425extern errcode_t ea_refcount_store(ext2_refcount_t refcount,
426				   blk_t blk, int count);
427extern blk_t ext2fs_get_refcount_size(ext2_refcount_t refcount);
428extern void ea_refcount_intr_begin(ext2_refcount_t refcount);
429extern blk_t ea_refcount_intr_next(ext2_refcount_t refcount, int *ret);
430
431/* ehandler.c */
432extern const char *ehandler_operation(const char *op);
433extern void ehandler_init(io_channel channel);
434
435/* journal.c */
436extern int e2fsck_check_ext3_journal(e2fsck_t ctx);
437extern int e2fsck_run_ext3_journal(e2fsck_t ctx);
438extern void e2fsck_move_ext3_journal(e2fsck_t ctx);
439extern int e2fsck_fix_ext3_journal_hint(e2fsck_t ctx);
440
441/* pass1.c */
442extern void e2fsck_setup_tdb_icount(e2fsck_t ctx, int flags,
443				    ext2_icount_t *ret);
444extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int bool);
445extern int e2fsck_pass1_check_device_inode(ext2_filsys fs,
446					   struct ext2_inode *inode);
447extern int e2fsck_pass1_check_symlink(ext2_filsys fs, ext2_ino_t ino,
448				      struct ext2_inode *inode, char *buf);
449extern void e2fsck_clear_inode(e2fsck_t ctx, ext2_ino_t ino,
450			       struct ext2_inode *inode, int restart_flag,
451			       const char *source);
452
453/* pass2.c */
454extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir,
455				    ext2_ino_t ino, char *buf);
456
457/* pass3.c */
458extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode);
459extern errcode_t e2fsck_expand_directory(e2fsck_t ctx, ext2_ino_t dir,
460					 int num, int gauranteed_size);
461extern ext2_ino_t e2fsck_get_lost_and_found(e2fsck_t ctx, int fix);
462extern errcode_t e2fsck_adjust_inode_count(e2fsck_t ctx, ext2_ino_t ino,
463					   int adj);
464
465
466/* region.c */
467extern region_t region_create(region_addr_t min, region_addr_t max);
468extern void region_free(region_t region);
469extern int region_allocate(region_t region, region_addr_t start, int n);
470
471/* rehash.c */
472errcode_t e2fsck_rehash_dir(e2fsck_t ctx, ext2_ino_t ino);
473void e2fsck_rehash_directories(e2fsck_t ctx);
474
475/* super.c */
476void check_super_block(e2fsck_t ctx);
477int check_backup_super_block(e2fsck_t ctx);
478void check_resize_inode(e2fsck_t ctx);
479
480/* util.c */
481extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
482				    const char *description);
483extern int ask(e2fsck_t ctx, const char * string, int def);
484extern int ask_yn(const char * string, int def);
485extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
486extern void e2fsck_read_bitmaps(e2fsck_t ctx);
487extern void e2fsck_write_bitmaps(e2fsck_t ctx);
488extern void preenhalt(e2fsck_t ctx);
489extern char *string_copy(e2fsck_t ctx, const char *str, int len);
490extern errcode_t e2fsck_zero_blocks(ext2_filsys fs, blk_t blk, int num,
491				    blk_t *ret_blk, int *ret_count);
492extern int fs_proc_check(const char *fs_name);
493extern int check_for_modules(const char *fs_name);
494#ifdef RESOURCE_TRACK
495extern void print_resource_track(e2fsck_t ctx,
496				 const char *desc,
497				 struct resource_track *track,
498				 io_channel channel);
499extern void init_resource_track(struct resource_track *track,
500				io_channel channel);
501#else
502#define print_resource_track(ctx, desc, track, channel) do { } while (0)
503#define init_resource_track(track, channel) do { } while (0)
504#endif
505extern int inode_has_valid_blocks(struct ext2_inode *inode);
506extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
507			      struct ext2_inode * inode, const char * proc);
508extern void e2fsck_read_inode_full(e2fsck_t ctx, unsigned long ino,
509				   struct ext2_inode *inode,
510				   const int bufsize, const char *proc);
511extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
512			       struct ext2_inode * inode, const char * proc);
513extern void e2fsck_write_inode_full(e2fsck_t ctx, unsigned long ino,
514                               struct ext2_inode * inode, int bufsize,
515                               const char *proc);
516#ifdef MTRACE
517extern void mtrace_print(char *mesg);
518#endif
519extern blk_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs,
520			   const char *name, io_manager manager);
521extern int ext2_file_type(unsigned int mode);
522extern int write_all(int fd, char *buf, size_t count);
523
524/* unix.c */
525extern void e2fsck_clear_progbar(e2fsck_t ctx);
526extern int e2fsck_simple_progress(e2fsck_t ctx, const char *label,
527				  float percent, unsigned int dpynum);
528#endif /* _E2FSCK_H */
529