Whamcloud - gitweb
libext2fs/e2fsck: refactor everyone who writes zero blocks to disk
[tools/e2fsprogs.git] / e2fsck / e2fsck.h
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 #ifdef __GNUC__
65 #define E2FSCK_ATTR(x) __attribute__(x)
66 #else
67 #define E2FSCK_ATTR(x)
68 #endif
69
70 #include "quota/quotaio.h"
71
72 /*
73  * Exit codes used by fsck-type programs
74  */
75 #define FSCK_OK          0      /* No errors */
76 #define FSCK_NONDESTRUCT 1      /* File system errors corrected */
77 #define FSCK_REBOOT      2      /* System should be rebooted */
78 #define FSCK_UNCORRECTED 4      /* File system errors left uncorrected */
79 #define FSCK_ERROR       8      /* Operational error */
80 #define FSCK_USAGE       16     /* Usage or syntax error */
81 #define FSCK_CANCELED    32     /* Aborted with a signal or ^C */
82 #define FSCK_LIBRARY     128    /* Shared library error */
83
84 /*
85  * The last ext2fs revision level that this version of e2fsck is able to
86  * support
87  */
88 #define E2FSCK_CURRENT_REV      1
89
90 /*
91  * The directory information structure; stores directory information
92  * collected in earlier passes, to avoid disk i/o in fetching the
93  * directory information.
94  */
95 struct dir_info {
96         ext2_ino_t              ino;    /* Inode number */
97         ext2_ino_t              dotdot; /* Parent according to '..' */
98         ext2_ino_t              parent; /* Parent according to treewalk */
99 };
100
101
102 /*
103  * The indexed directory information structure; stores information for
104  * directories which contain a hash tree index.
105  */
106 struct dx_dir_info {
107         ext2_ino_t              ino;            /* Inode number */
108         int                     numblocks;      /* number of blocks */
109         int                     hashversion;
110         short                   depth;          /* depth of tree */
111         struct dx_dirblock_info *dx_block;      /* Array of size numblocks */
112 };
113
114 #define DX_DIRBLOCK_ROOT        1
115 #define DX_DIRBLOCK_LEAF        2
116 #define DX_DIRBLOCK_NODE        3
117 #define DX_DIRBLOCK_CORRUPT     4
118 #define DX_DIRBLOCK_CLEARED     8
119
120 struct dx_dirblock_info {
121         int             type;
122         blk64_t         phys;
123         int             flags;
124         blk64_t         parent;
125         ext2_dirhash_t  min_hash;
126         ext2_dirhash_t  max_hash;
127         ext2_dirhash_t  node_min_hash;
128         ext2_dirhash_t  node_max_hash;
129 };
130
131 #define DX_FLAG_REFERENCED      1
132 #define DX_FLAG_DUP_REF         2
133 #define DX_FLAG_FIRST           4
134 #define DX_FLAG_LAST            8
135
136 #define RESOURCE_TRACK
137
138 #ifdef RESOURCE_TRACK
139 /*
140  * This structure is used for keeping track of how much resources have
141  * been used for a particular pass of e2fsck.
142  */
143 struct resource_track {
144         struct timeval time_start;
145         struct timeval user_start;
146         struct timeval system_start;
147         void    *brk_start;
148         unsigned long long bytes_read;
149         unsigned long long bytes_written;
150 };
151 #endif
152
153 /*
154  * E2fsck options
155  */
156 #define E2F_OPT_READONLY        0x0001
157 #define E2F_OPT_PREEN           0x0002
158 #define E2F_OPT_YES             0x0004
159 #define E2F_OPT_NO              0x0008
160 #define E2F_OPT_TIME            0x0010
161 #define E2F_OPT_TIME2           0x0020
162 #define E2F_OPT_CHECKBLOCKS     0x0040
163 #define E2F_OPT_DEBUG           0x0080
164 #define E2F_OPT_FORCE           0x0100
165 #define E2F_OPT_WRITECHECK      0x0200
166 #define E2F_OPT_COMPRESS_DIRS   0x0400
167 #define E2F_OPT_FRAGCHECK       0x0800
168 #define E2F_OPT_JOURNAL_ONLY    0x1000 /* only replay the journal */
169 #define E2F_OPT_DISCARD         0x2000
170
171 /*
172  * E2fsck flags
173  */
174 #define E2F_FLAG_ABORT          0x0001 /* Abort signaled */
175 #define E2F_FLAG_CANCEL         0x0002 /* Cancel signaled */
176 #define E2F_FLAG_SIGNAL_MASK    0x0003
177 #define E2F_FLAG_RESTART        0x0004 /* Restart signaled */
178 #define E2F_FLAG_RESTART_LATER  0x0008 /* Restart after all iterations done */
179
180 #define E2F_FLAG_SETJMP_OK      0x0010 /* Setjmp valid for abort */
181
182 #define E2F_FLAG_PROG_BAR       0x0020 /* Progress bar on screen */
183 #define E2F_FLAG_PROG_SUPPRESS  0x0040 /* Progress suspended */
184 #define E2F_FLAG_JOURNAL_INODE  0x0080 /* Create a new ext3 journal inode */
185 #define E2F_FLAG_SB_SPECIFIED   0x0100 /* The superblock was explicitly
186                                         * specified by the user */
187 #define E2F_FLAG_RESTARTED      0x0200 /* E2fsck has been restarted */
188 #define E2F_FLAG_RESIZE_INODE   0x0400 /* Request to recreate resize inode */
189 #define E2F_FLAG_GOT_DEVSIZE    0x0800 /* Device size has been fetched */
190 #define E2F_FLAG_EXITING        0x1000 /* E2fsck exiting due to errors */
191 #define E2F_FLAG_TIME_INSANE    0x2000 /* Time is insane */
192 #define E2F_FLAG_PROBLEMS_FIXED 0x4000 /* At least one problem was fixed */
193
194 #define E2F_RESET_FLAGS (E2F_FLAG_TIME_INSANE | E2F_FLAG_PROBLEMS_FIXED)
195
196 /*
197  * Defines for indicating the e2fsck pass number
198  */
199 #define E2F_PASS_1      1
200 #define E2F_PASS_2      2
201 #define E2F_PASS_3      3
202 #define E2F_PASS_4      4
203 #define E2F_PASS_5      5
204 #define E2F_PASS_1B     6
205
206 /*
207  * Define the extended attribute refcount structure
208  */
209 typedef struct ea_refcount *ext2_refcount_t;
210
211 /*
212  * This is the global e2fsck structure.
213  */
214 typedef struct e2fsck_struct *e2fsck_t;
215
216 #define MAX_EXTENT_DEPTH_COUNT 5
217
218 struct e2fsck_struct {
219         ext2_filsys fs;
220         const char *program_name;
221         char *filesystem_name;
222         char *device_name;
223         char *io_options;
224         FILE    *logf;
225         char    *log_fn;
226         int     flags;          /* E2fsck internal flags */
227         int     options;
228         int     blocksize;      /* blocksize */
229         blk64_t use_superblock; /* sb requested by user */
230         blk64_t superblock;     /* sb used to open fs */
231         blk64_t num_blocks;     /* Total number of blocks */
232         blk64_t free_blocks;
233         ino_t   free_inodes;
234         int     mount_flags;
235         int     openfs_flags;
236         blkid_cache blkid;      /* blkid cache */
237
238 #ifdef HAVE_SETJMP_H
239         jmp_buf abort_loc;
240 #endif
241         unsigned long abort_code;
242
243         int (*progress)(e2fsck_t ctx, int pass, unsigned long cur,
244                         unsigned long max);
245
246         ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */
247         ext2fs_inode_bitmap inode_bad_map; /* Inodes which are bad somehow */
248         ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */
249         ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */
250         ext2fs_inode_bitmap inode_imagic_map; /* AFS inodes */
251         ext2fs_inode_bitmap inode_reg_map; /* Inodes which are regular files*/
252
253         ext2fs_block_bitmap block_found_map; /* Blocks which are in use */
254         ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */
255         ext2fs_block_bitmap block_ea_map; /* Blocks which are used by EA's */
256
257         /*
258          * Inode count arrays
259          */
260         ext2_icount_t   inode_count;
261         ext2_icount_t inode_link_info;
262
263         ext2_refcount_t refcount;
264         ext2_refcount_t refcount_extra;
265
266         /*
267          * Array of flags indicating whether an inode bitmap, block
268          * bitmap, or inode table is invalid
269          */
270         int *invalid_inode_bitmap_flag;
271         int *invalid_block_bitmap_flag;
272         int *invalid_inode_table_flag;
273         int invalid_bitmaps;    /* There are invalid bitmaps/itable */
274
275         /*
276          * Block buffer
277          */
278         char *block_buf;
279
280         /*
281          * For pass1_check_directory and pass1_get_blocks
282          */
283         ext2_ino_t stashed_ino;
284         struct ext2_inode *stashed_inode;
285
286         /*
287          * Location of the lost and found directory
288          */
289         ext2_ino_t lost_and_found;
290         int bad_lost_and_found;
291
292         /*
293          * Directory information
294          */
295         struct dir_info_db      *dir_info;
296
297         /*
298          * Indexed directory information
299          */
300         int             dx_dir_info_count;
301         int             dx_dir_info_size;
302         struct dx_dir_info *dx_dir_info;
303
304         /*
305          * Directories to hash
306          */
307         ext2_u32_list   dirs_to_hash;
308
309         /*
310          * Tuning parameters
311          */
312         int process_inode_size;
313         int inode_buffer_blocks;
314         unsigned int htree_slack_percentage;
315
316         /*
317          * ext3 journal support
318          */
319         io_channel      journal_io;
320         char    *journal_name;
321
322         /*
323          * Ext4 quota support
324          */
325         quota_ctx_t qctx;
326 #ifdef RESOURCE_TRACK
327         /*
328          * For timing purposes
329          */
330         struct resource_track   global_rtrack;
331 #endif
332
333         /*
334          * How we display the progress update (for unix)
335          */
336         int progress_fd;
337         int progress_pos;
338         int progress_last_percent;
339         unsigned int progress_last_time;
340         int interactive;        /* Are we connected directly to a tty? */
341         char start_meta[2], stop_meta[2];
342
343         /* File counts */
344         __u32 fs_directory_count;
345         __u32 fs_regular_count;
346         __u32 fs_blockdev_count;
347         __u32 fs_chardev_count;
348         __u32 fs_links_count;
349         __u32 fs_symlinks_count;
350         __u32 fs_fast_symlinks_count;
351         __u32 fs_fifo_count;
352         __u32 fs_total_count;
353         __u32 fs_badblocks_count;
354         __u32 fs_sockets_count;
355         __u32 fs_ind_count;
356         __u32 fs_dind_count;
357         __u32 fs_tind_count;
358         __u32 fs_fragmented;
359         __u32 fs_fragmented_dir;
360         __u32 large_files;
361         __u32 fs_ext_attr_inodes;
362         __u32 fs_ext_attr_blocks;
363         __u32 extent_depth_count[MAX_EXTENT_DEPTH_COUNT];
364
365         /* misc fields */
366         time_t now;
367         time_t time_fudge;      /* For working around buggy init scripts */
368         int ext_attr_ver;
369         profile_t       profile;
370         int blocks_per_page;
371
372         /* Reserve blocks for root and l+f re-creation */
373         blk64_t root_repair_block, lnf_repair_block;
374
375         /*
376          * For the use of callers of the e2fsck functions; not used by
377          * e2fsck functions themselves.
378          */
379         void *priv_data;
380         ext2fs_block_bitmap block_metadata_map; /* Metadata blocks */
381 };
382
383 /* Used by the region allocation code */
384 typedef __u64 region_addr_t;
385 typedef struct region_struct *region_t;
386
387 #ifndef HAVE_STRNLEN
388 #define strnlen(str, x) e2fsck_strnlen((str),(x))
389 extern int e2fsck_strnlen(const char * s, int count);
390 #endif
391
392 /*
393  * Procedure declarations
394  */
395
396 extern void e2fsck_pass1(e2fsck_t ctx);
397 extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf);
398 extern void e2fsck_pass2(e2fsck_t ctx);
399 extern void e2fsck_pass3(e2fsck_t ctx);
400 extern void e2fsck_pass4(e2fsck_t ctx);
401 extern void e2fsck_pass5(e2fsck_t ctx);
402
403 /* e2fsck.c */
404 extern errcode_t e2fsck_allocate_context(e2fsck_t *ret);
405 extern errcode_t e2fsck_reset_context(e2fsck_t ctx);
406 extern void e2fsck_free_context(e2fsck_t ctx);
407 extern int e2fsck_run(e2fsck_t ctx);
408
409
410 /* badblock.c */
411 extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
412                                  int replace_bad_blocks);
413
414 /* dirinfo.c */
415 extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent);
416 extern void e2fsck_free_dir_info(e2fsck_t ctx);
417 extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
418 extern struct dir_info_iter *e2fsck_dir_info_iter_begin(e2fsck_t ctx);
419 extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx,
420                                              struct dir_info_iter *);
421 extern void e2fsck_dir_info_iter_end(e2fsck_t ctx, struct dir_info_iter *);
422 extern int e2fsck_dir_info_set_parent(e2fsck_t ctx, ext2_ino_t ino,
423                                       ext2_ino_t parent);
424 extern int e2fsck_dir_info_set_dotdot(e2fsck_t ctx, ext2_ino_t ino,
425                                       ext2_ino_t dotdot);
426 extern int e2fsck_dir_info_get_parent(e2fsck_t ctx, ext2_ino_t ino,
427                                       ext2_ino_t *parent);
428 extern int e2fsck_dir_info_get_dotdot(e2fsck_t ctx, ext2_ino_t ino,
429                                       ext2_ino_t *dotdot);
430
431 /* dx_dirinfo.c */
432 extern void e2fsck_add_dx_dir(e2fsck_t ctx, ext2_ino_t ino, int num_blocks);
433 extern struct dx_dir_info *e2fsck_get_dx_dir_info(e2fsck_t ctx, ext2_ino_t ino);
434 extern void e2fsck_free_dx_dir_info(e2fsck_t ctx);
435 extern int e2fsck_get_num_dx_dirinfo(e2fsck_t ctx);
436 extern struct dx_dir_info *e2fsck_dx_dir_info_iter(e2fsck_t ctx, int *control);
437
438 /* ea_refcount.c */
439 extern errcode_t ea_refcount_create(int size, ext2_refcount_t *ret);
440 extern void ea_refcount_free(ext2_refcount_t refcount);
441 extern errcode_t ea_refcount_fetch(ext2_refcount_t refcount, blk64_t blk, int *ret);
442 extern errcode_t ea_refcount_increment(ext2_refcount_t refcount,
443                                        blk64_t blk, int *ret);
444 extern errcode_t ea_refcount_decrement(ext2_refcount_t refcount,
445                                        blk64_t blk, int *ret);
446 extern errcode_t ea_refcount_store(ext2_refcount_t refcount,
447                                    blk64_t blk, int count);
448 extern blk_t ext2fs_get_refcount_size(ext2_refcount_t refcount);
449 extern void ea_refcount_intr_begin(ext2_refcount_t refcount);
450 extern blk64_t ea_refcount_intr_next(ext2_refcount_t refcount, int *ret);
451
452 /* ehandler.c */
453 extern const char *ehandler_operation(const char *op);
454 extern void ehandler_init(io_channel channel);
455
456 /* journal.c */
457 extern errcode_t e2fsck_check_ext3_journal(e2fsck_t ctx);
458 extern errcode_t e2fsck_run_ext3_journal(e2fsck_t ctx);
459 extern void e2fsck_move_ext3_journal(e2fsck_t ctx);
460 extern int e2fsck_fix_ext3_journal_hint(e2fsck_t ctx);
461
462 /* logfile.c */
463 extern void set_up_logging(e2fsck_t ctx);
464
465 /* quota.c */
466 extern void e2fsck_hide_quota(e2fsck_t ctx);
467
468 /* pass1.c */
469 extern void e2fsck_setup_tdb_icount(e2fsck_t ctx, int flags,
470                                     ext2_icount_t *ret);
471 extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int use_shortcuts);
472 extern int e2fsck_pass1_check_device_inode(ext2_filsys fs,
473                                            struct ext2_inode *inode);
474 extern int e2fsck_pass1_check_symlink(ext2_filsys fs, ext2_ino_t ino,
475                                       struct ext2_inode *inode, char *buf);
476 extern void e2fsck_clear_inode(e2fsck_t ctx, ext2_ino_t ino,
477                                struct ext2_inode *inode, int restart_flag,
478                                const char *source);
479 extern void e2fsck_intercept_block_allocations(e2fsck_t ctx);
480
481 /* pass2.c */
482 extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir,
483                                     ext2_ino_t ino, char *buf);
484
485 /* pass3.c */
486 extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode);
487 extern errcode_t e2fsck_expand_directory(e2fsck_t ctx, ext2_ino_t dir,
488                                          int num, int gauranteed_size);
489 extern ext2_ino_t e2fsck_get_lost_and_found(e2fsck_t ctx, int fix);
490 extern errcode_t e2fsck_adjust_inode_count(e2fsck_t ctx, ext2_ino_t ino,
491                                            int adj);
492
493
494 /* region.c */
495 extern region_t region_create(region_addr_t min, region_addr_t max);
496 extern void region_free(region_t region);
497 extern int region_allocate(region_t region, region_addr_t start, int n);
498
499 /* rehash.c */
500 void e2fsck_rehash_dir_later(e2fsck_t ctx, ext2_ino_t ino);
501 int e2fsck_dir_will_be_rehashed(e2fsck_t ctx, ext2_ino_t ino);
502 errcode_t e2fsck_rehash_dir(e2fsck_t ctx, ext2_ino_t ino);
503 void e2fsck_rehash_directories(e2fsck_t ctx);
504
505 /* sigcatcher.c */
506 void sigcatcher_setup(void);
507
508 /* super.c */
509 void check_super_block(e2fsck_t ctx);
510 int check_backup_super_block(e2fsck_t ctx);
511 void check_resize_inode(e2fsck_t ctx);
512
513 /* util.c */
514 extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
515                                     const char *description);
516 extern int ask(e2fsck_t ctx, const char * string, int def);
517 extern int ask_yn(e2fsck_t ctx, const char * string, int def);
518 extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
519 extern void log_out(e2fsck_t ctx, const char *fmt, ...)
520         E2FSCK_ATTR((format(printf, 2, 3)));
521 extern void log_err(e2fsck_t ctx, const char *fmt, ...)
522         E2FSCK_ATTR((format(printf, 2, 3)));
523 extern void e2fsck_read_bitmaps(e2fsck_t ctx);
524 extern void e2fsck_write_bitmaps(e2fsck_t ctx);
525 extern void preenhalt(e2fsck_t ctx);
526 extern char *string_copy(e2fsck_t ctx, const char *str, int len);
527 extern int fs_proc_check(const char *fs_name);
528 extern int check_for_modules(const char *fs_name);
529 #ifdef RESOURCE_TRACK
530 extern void print_resource_track(e2fsck_t ctx,
531                                  const char *desc,
532                                  struct resource_track *track,
533                                  io_channel channel);
534 extern void init_resource_track(struct resource_track *track,
535                                 io_channel channel);
536 #else
537 #define print_resource_track(ctx, desc, track, channel) do { } while (0)
538 #define init_resource_track(track, channel) do { } while (0)
539 #endif
540 extern int inode_has_valid_blocks(struct ext2_inode *inode);
541 extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
542                               struct ext2_inode * inode, const char * proc);
543 extern void e2fsck_read_inode_full(e2fsck_t ctx, unsigned long ino,
544                                    struct ext2_inode *inode,
545                                    const int bufsize, const char *proc);
546 extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
547                                struct ext2_inode * inode, const char * proc);
548 extern void e2fsck_write_inode_full(e2fsck_t ctx, unsigned long ino,
549                                struct ext2_inode * inode, int bufsize,
550                                const char *proc);
551 #ifdef MTRACE
552 extern void mtrace_print(char *mesg);
553 #endif
554 extern blk64_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs,
555                            const char *name, io_manager manager);
556 extern int ext2_file_type(unsigned int mode);
557 extern int write_all(int fd, char *buf, size_t count);
558 void dump_mmp_msg(struct mmp_struct *mmp, const char *msg);
559 errcode_t e2fsck_mmp_update(ext2_filsys fs);
560
561 extern void e2fsck_set_bitmap_type(ext2_filsys fs,
562                                    unsigned int default_type,
563                                    const char *profile_name,
564                                    unsigned int *old_type);
565 extern errcode_t e2fsck_allocate_inode_bitmap(ext2_filsys fs,
566                                               const char *descr,
567                                               int default_type,
568                                               const char *profile_name,
569                                               ext2fs_inode_bitmap *ret);
570 extern errcode_t e2fsck_allocate_block_bitmap(ext2_filsys fs,
571                                               const char *descr,
572                                               int default_type,
573                                               const char *profile_name,
574                                               ext2fs_block_bitmap *ret);
575 extern errcode_t e2fsck_allocate_subcluster_bitmap(ext2_filsys fs,
576                                                    const char *descr,
577                                                    int default_type,
578                                                    const char *profile_name,
579                                                    ext2fs_block_bitmap *ret);
580
581 /* unix.c */
582 extern void e2fsck_clear_progbar(e2fsck_t ctx);
583 extern int e2fsck_simple_progress(e2fsck_t ctx, const char *label,
584                                   float percent, unsigned int dpynum);
585 #endif /* _E2FSCK_H */