Whamcloud - gitweb
320067279538440d2e284e5613530407fd1efc87
[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 #include <stddef.h>
15 #ifdef HAVE_UNISTD_H
16 #include <unistd.h>
17 #endif
18 #include <stdlib.h>
19 #include <time.h>
20 #ifdef HAVE_SYS_TYPES_H
21 #include <sys/types.h>
22 #endif
23 #ifdef HAVE_SYS_TIME_H
24 #include <sys/time.h>
25 #endif
26 #ifdef HAVE_SETJMP_H
27 #include <setjmp.h>
28 #endif
29
30 #if EXT2_FLAT_INCLUDES
31 #include "ext2_fs.h"
32 #include "ext2fs.h"
33 #include "blkid.h"
34 #else
35 #include "ext2fs/ext2_fs.h"
36 #include "ext2fs/ext2fs.h"
37 #include "blkid/blkid.h"
38 #endif
39
40 #include "support/profile.h"
41 #include "support/prof_err.h"
42
43 #ifdef ENABLE_NLS
44 #include <libintl.h>
45 #include <locale.h>
46 #define _(a) (gettext (a))
47 #ifdef gettext_noop
48 #define N_(a) gettext_noop (a)
49 #else
50 #define N_(a) (a)
51 #endif
52 #define P_(singular, plural, n) (ngettext (singular, plural, n))
53 #ifndef NLS_CAT_NAME
54 #define NLS_CAT_NAME "e2fsprogs"
55 #endif
56 #ifndef LOCALEDIR
57 #define LOCALEDIR "/usr/share/locale"
58 #endif
59 #else
60 #define _(a) (a)
61 #define N_(a) a
62 #define P_(singular, plural, n) ((n) == 1 ? (singular) : (plural))
63 #endif
64
65 #ifdef __GNUC__
66 #define E2FSCK_ATTR(x) __attribute__(x)
67 #else
68 #define E2FSCK_ATTR(x)
69 #endif
70
71 #include "support/quotaio.h"
72 #if __GNUC_PREREQ (4, 6)
73 #pragma GCC diagnostic push
74 #pragma GCC diagnostic ignored "-Wunused-function"
75 #endif
76 #include "ext2fs/fast_commit.h"
77 #if __GNUC_PREREQ (4, 6)
78 #pragma GCC diagnostic pop
79 #endif
80
81 /*
82  * Exit codes used by fsck-type programs
83  */
84 #define FSCK_OK          0      /* No errors */
85 #define FSCK_NONDESTRUCT 1      /* File system errors corrected */
86 #define FSCK_REBOOT      2      /* System should be rebooted */
87 #define FSCK_UNCORRECTED 4      /* File system errors left uncorrected */
88 #define FSCK_ERROR       8      /* Operational error */
89 #define FSCK_USAGE       16     /* Usage or syntax error */
90 #define FSCK_CANCELED    32     /* Aborted with a signal or ^C */
91 #define FSCK_LIBRARY     128    /* Shared library error */
92
93 /*
94  * The last ext2fs revision level that this version of e2fsck is able to
95  * support
96  */
97 #define E2FSCK_CURRENT_REV      1
98
99 /*
100  * The directory information structure; stores directory information
101  * collected in earlier passes, to avoid disk i/o in fetching the
102  * directory information.
103  */
104 struct dir_info {
105         ext2_ino_t              ino;    /* Inode number */
106         ext2_ino_t              dotdot; /* Parent according to '..' */
107         ext2_ino_t              parent; /* Parent according to treewalk */
108 };
109
110
111 /*
112  * The indexed directory information structure; stores information for
113  * directories which contain a hash tree index.
114  */
115 struct dx_dir_info {
116         ext2_ino_t              ino;            /* Inode number */
117         short                   depth;          /* depth of tree (15 bits) */
118         __u8                    hashversion;
119         __u8                    casefolded_hash:1;
120         blk_t                   numblocks;      /* number of blocks in dir */
121         struct dx_dirblock_info *dx_block;      /* Array of size numblocks */
122 };
123
124 #define DX_DIRBLOCK_ROOT        1
125 #define DX_DIRBLOCK_LEAF        2
126 #define DX_DIRBLOCK_NODE        3
127 #define DX_DIRBLOCK_CORRUPT     4
128 #define DX_DIRBLOCK_CLEARED     8
129
130 struct dx_dirblock_info {
131         int             type;
132         int             flags;
133         blk64_t         phys;
134         blk64_t         parent;
135         blk64_t         previous;
136         ext2_dirhash_t  min_hash;
137         ext2_dirhash_t  max_hash;
138         ext2_dirhash_t  node_min_hash;
139         ext2_dirhash_t  node_max_hash;
140 };
141
142 #define DX_FLAG_REFERENCED      1
143 #define DX_FLAG_DUP_REF         2
144 #define DX_FLAG_FIRST           4
145 #define DX_FLAG_LAST            8
146
147 struct encrypted_file_info;
148
149 #define RESOURCE_TRACK
150
151 #ifdef RESOURCE_TRACK
152 /*
153  * This structure is used for keeping track of how much resources have
154  * been used for a particular pass of e2fsck.
155  */
156 struct resource_track {
157         struct timeval time_start;
158         struct timeval user_start;
159         struct timeval system_start;
160         void    *brk_start;
161         unsigned long long bytes_read;
162         unsigned long long bytes_written;
163 };
164 #endif
165
166 /*
167  * E2fsck options
168  */
169 #define E2F_OPT_READONLY        0x0001
170 #define E2F_OPT_PREEN           0x0002
171 #define E2F_OPT_YES             0x0004
172 #define E2F_OPT_NO              0x0008
173 #define E2F_OPT_TIME            0x0010
174 #define E2F_OPT_TIME2           0x0020
175 #define E2F_OPT_CHECKBLOCKS     0x0040
176 #define E2F_OPT_DEBUG           0x0080
177 #define E2F_OPT_FORCE           0x0100
178 #define E2F_OPT_WRITECHECK      0x0200
179 #define E2F_OPT_COMPRESS_DIRS   0x0400
180 #define E2F_OPT_FRAGCHECK       0x0800
181 #define E2F_OPT_JOURNAL_ONLY    0x1000 /* only replay the journal */
182 #define E2F_OPT_DISCARD         0x2000
183 #define E2F_OPT_CONVERT_BMAP    0x4000 /* convert blockmap to extent */
184 #define E2F_OPT_FIXES_ONLY      0x8000 /* skip all optimizations */
185 #define E2F_OPT_NOOPT_EXTENTS   0x10000 /* don't optimize extents */
186 #define E2F_OPT_ICOUNT_FULLMAP  0x20000 /* use an array for inode counts */
187 #define E2F_OPT_UNSHARE_BLOCKS  0x40000
188 #define E2F_OPT_CLEAR_UNINIT    0x80000 /* Hack to clear the uninit bit */
189 #define E2F_OPT_CHECK_ENCODING  0x100000 /* Force verification of encoded filenames */
190 #define E2F_OPT_MULTITHREAD     0x200000 /* Use multiple threads to speedup */
191
192 /*
193  * E2fsck flags
194  */
195 #define E2F_FLAG_ABORT          0x0001 /* Abort signaled */
196 #define E2F_FLAG_CANCEL         0x0002 /* Cancel signaled */
197 #define E2F_FLAG_SIGNAL_MASK    (E2F_FLAG_ABORT | E2F_FLAG_CANCEL)
198 #define E2F_FLAG_RESTART        0x0004 /* Restart signaled */
199 #define E2F_FLAG_RUN_RETURN     (E2F_FLAG_SIGNAL_MASK | E2F_FLAG_RESTART)
200 #define E2F_FLAG_RESTART_LATER  0x0008 /* Restart after all iterations done */
201 #define E2F_FLAG_SETJMP_OK      0x0010 /* Setjmp valid for abort */
202
203 #define E2F_FLAG_PROG_BAR       0x0020 /* Progress bar on screen */
204 #define E2F_FLAG_PROG_SUPPRESS  0x0040 /* Progress suspended */
205 #define E2F_FLAG_JOURNAL_INODE  0x0080 /* Create a new ext3 journal inode */
206 #define E2F_FLAG_SB_SPECIFIED   0x0100 /* The superblock was explicitly
207                                         * specified by the user */
208 #define E2F_FLAG_RESTARTED      0x0200 /* E2fsck has been restarted */
209 #define E2F_FLAG_RESIZE_INODE   0x0400 /* Request to recreate resize inode */
210 #define E2F_FLAG_GOT_DEVSIZE    0x0800 /* Device size has been fetched */
211 #define E2F_FLAG_EXITING        0x1000 /* E2fsck exiting due to errors */
212 #define E2F_FLAG_TIME_INSANE    0x2000 /* Time is insane */
213 #define E2F_FLAG_PROBLEMS_FIXED 0x4000 /* At least one problem was fixed */
214 #define E2F_FLAG_ALLOC_OK       0x8000 /* Can we allocate blocks? */
215 #define E2F_FLAG_EXPAND_EISIZE  0x10000 /* Expand the inodes (i_extra_isize) */
216 #define E2F_FLAG_DUP_BLOCK      0x20000 /* dup block found during pass1 */
217
218 #define E2F_RESET_FLAGS (E2F_FLAG_TIME_INSANE | E2F_FLAG_PROBLEMS_FIXED)
219
220 /*
221  * Defines for indicating the e2fsck pass number
222  */
223 #define E2F_PASS_1      1
224 #define E2F_PASS_2      2
225 #define E2F_PASS_3      3
226 #define E2F_PASS_4      4
227 #define E2F_PASS_5      5
228 #define E2F_PASS_1B     6
229
230 enum shared_opt {
231         E2F_SHARED_PRESERVE = 0,
232         E2F_SHARED_DELETE,
233         E2F_SHARED_LPF
234 };
235
236 enum clone_opt {
237         E2F_CLONE_DUP = 0,
238         E2F_CLONE_ZERO
239 };
240
241 #define EXT4_FITS_IN_INODE(ext4_inode, einode, field)   \
242         ((offsetof(typeof(*ext4_inode), field) +        \
243           sizeof(ext4_inode->field)) <=                 \
244            (EXT2_GOOD_OLD_INODE_SIZE +                  \
245             (einode)->i_extra_isize))                   \
246
247 #define EXT4_XTIME_FUTURE(ctx, sb, xtime, margin)       \
248         (!((ctx)->flags & E2F_FLAG_TIME_INSANE) &&      \
249          (xtime) > (ctx)->now + (margin))
250 #define EXT4_XTIME_ANCIENT(ctx, sb, xtime, margin)      \
251         ((sb)->s_mkfs_time > (margin) && (xtime) < (sb)->s_mkfs_time - (margin))
252
253 #define BADNESS_THRESHOLD       12
254 #define BADNESS_MAX             0x7fff
255
256 /*
257  * Define the extended attribute refcount structure
258  */
259 typedef struct ea_refcount *ext2_refcount_t;
260
261 /*
262  * This is the global e2fsck structure.
263  */
264 typedef struct e2fsck_struct *e2fsck_t;
265
266 #define MAX_EXTENT_DEPTH_COUNT 8
267
268 /*
269  * This strucutre is used to manage the list of extents in a file. Placing
270  * it here since this is used by fast_commit.h.
271  */
272 struct extent_list {
273         blk64_t blocks_freed;
274         struct ext2fs_extent *extents;
275         unsigned int count;
276         unsigned int size;
277         unsigned int ext_read;
278         errcode_t retval;
279         ext2_ino_t ino;
280 };
281
282 /* State structure for fast commit replay */
283 struct e2fsck_fc_replay_state {
284         struct extent_list fc_extent_list;
285         int fc_replay_num_tags;
286         int fc_replay_expected_off;
287         enum passtype fc_current_pass;
288         int fc_cur_tag;
289         unsigned int fc_crc;
290         __u16 fc_super_state;
291 };
292
293 #ifdef HAVE_PTHREAD
294 /*
295  * Fields that used for multi-thread
296  */
297 struct e2fsck_thread {
298         /* Thread index */
299         int             et_thread_index;
300         /* The start group number for this thread */
301         dgrp_t          et_group_start;
302         /* The end (not included) group number for this thread*/
303         dgrp_t          et_group_end;
304         /* The next group number to check */
305         dgrp_t          et_group_next;
306         /* Scanned inode number */
307         ext2_ino_t      et_inode_number;
308         int             et_log_length;
309         char            et_log_buf[2048];
310 };
311 #endif
312
313 struct e2fsck_struct {
314         /* Global context to get the cancel flag */
315         e2fsck_t                global_ctx;
316         ext2_filsys fs; /* [fs_fix_rwlock] */
317         const char *program_name;
318         char *filesystem_name;
319         char *device_name;
320         char *io_options;
321         FILE    *logf;
322         char    *log_fn;
323         FILE    *problem_logf;
324         char    *problem_log_fn;
325         /* E2fsck internal flags.
326          * shared by different threads for pass1 [fs_fix_rwlock] */
327         int     flags;
328         int     options;
329         unsigned blocksize;     /* blocksize */
330         blk64_t use_superblock; /* sb requested by user */
331         blk64_t superblock;     /* sb used to open fs */
332         blk64_t num_blocks;     /* Total number of blocks */
333         blk64_t free_blocks;
334         ext2_ino_t free_inodes;
335         int     mount_flags;
336         int     openfs_flags;
337         io_manager io_manager;
338         blkid_cache blkid;      /* blkid cache */
339
340 #ifdef HAVE_SETJMP_H
341         jmp_buf abort_loc;
342 #endif
343         unsigned long abort_code;
344
345         int (*progress)(e2fsck_t ctx, int pass, unsigned long cur,
346                         unsigned long max);
347
348         /* The following inode bitmaps are separately used in thread_ctx Pass1*/
349         ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */
350         ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */
351         ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */
352         ext2fs_inode_bitmap inode_imagic_map; /* AFS inodes */
353         ext2fs_inode_bitmap inode_reg_map; /* Inodes which are regular files*/
354         ext2fs_inode_bitmap inode_casefold_map; /* Inodes which are casefolded */
355
356         /* Following 3 protected by [fs_block_map_rwlock] */
357         ext2fs_block_bitmap block_found_map; /* Blocks which are in use */
358         ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */
359         ext2fs_block_bitmap block_ea_map; /* Blocks which are used by EA's */
360
361         /*
362          * Inode count arrays.
363          * Separately used in thread_ctx, pass1
364          */
365         ext2_icount_t   inode_count;
366         ext2_icount_t inode_link_info;
367         ext2_icount_t inode_badness;
368         unsigned int inode_badness_threshold;
369
370         ext2_refcount_t refcount;
371         ext2_refcount_t refcount_extra;
372         ext2_refcount_t refcount_orig;
373
374         /*
375          * Quota blocks and inodes to be charged for each ea block.
376          */
377         ext2_refcount_t ea_block_quota_blocks;
378         ext2_refcount_t ea_block_quota_inodes;
379
380         /*
381          * ea_inode references from attr entries.
382          */
383         ext2_refcount_t ea_inode_refs;
384
385         /*
386          * Array of flags indicating whether an inode bitmap, block
387          * bitmap, or inode table is invalid.
388          * Separately used in thread_ctx, pass1
389          */
390         int *invalid_inode_bitmap_flag;
391         int *invalid_block_bitmap_flag;
392         int *invalid_inode_table_flag;
393         int invalid_bitmaps;    /* There are invalid bitmaps/itable */
394
395         /*
396          * Block buffer
397          */
398         char *block_buf;
399
400         /*
401          * For pass1_check_directory and pass1_get_blocks.
402          * Separately used in thread_ctx in pass1
403          */
404         ext2_ino_t              stashed_ino;
405         struct ext2_inode       *stashed_inode;
406
407         /*
408          * Location of the lost and found directory
409          */
410         ext2_ino_t lost_and_found;
411         int bad_lost_and_found;
412
413         /*
414          * Directory information
415          */
416         struct dir_info_db      *dir_info;
417
418         /*
419          * Indexed directory information
420          */
421         ext2_ino_t              dx_dir_info_count;
422         ext2_ino_t              dx_dir_info_size;
423         struct dx_dir_info      *dx_dir_info;
424
425         /*
426          * Directories to hash
427          */
428         ext2_u32_list   dirs_to_hash;
429
430         /*
431          * Encrypted file information
432          */
433         struct encrypted_file_info *encrypted_files;
434
435         /*
436          * Tuning parameters
437          */
438         int process_inode_size;
439         int inode_buffer_blocks;
440         unsigned int htree_slack_percentage;
441
442         /*
443          * ext3 journal support
444          */
445         io_channel      journal_io;
446         char    *journal_name;
447
448         /*
449          * Ext4 quota support
450          */
451         quota_ctx_t qctx;
452 #ifdef RESOURCE_TRACK
453         /*
454          * For timing purposes
455          */
456         struct resource_track   global_rtrack;
457 #endif
458
459         /*
460          * How we display the progress update (for unix)
461          * shared by different threads for pass1 [fs_fix_rwlock]
462          */
463         int progress_fd;
464         int progress_pos;
465         int progress_last_percent;
466         unsigned int progress_last_time;
467         int interactive;        /* Are we connected directly to a tty? */
468         char start_meta[2], stop_meta[2];
469
470         /* File counts. Separately used in thread_ctx, pass1 */
471         __u32 fs_directory_count;
472         __u32 fs_regular_count;
473         __u32 fs_blockdev_count;
474         __u32 fs_chardev_count;
475         __u32 fs_links_count;
476         __u32 fs_symlinks_count;
477         __u32 fs_fast_symlinks_count;
478         __u32 fs_fifo_count;
479         __u32 fs_total_count;
480         __u32 fs_badblocks_count;
481         __u32 fs_sockets_count;
482         __u32 fs_ind_count;
483         __u32 fs_dind_count;
484         __u32 fs_tind_count;
485         __u32 fs_fragmented;
486         __u32 fs_fragmented_dir;
487         __u32 large_files;
488         __u32 large_dirs;
489         __u32 fs_ext_attr_inodes;
490         __u32 fs_ext_attr_blocks;
491         __u32 extent_depth_count[MAX_EXTENT_DEPTH_COUNT];
492
493         /* misc fields */
494         time_t now;
495         time_t time_fudge;      /* For working around buggy init scripts */
496         int ext_attr_ver;
497         enum shared_opt shared;
498         enum clone_opt clone;
499         profile_t       profile;
500         int blocks_per_page;
501         ext2_u32_list casefolded_dirs;
502
503         /* Expand large inodes to atleast these many bytes */
504         int want_extra_isize;
505         /* minimum i_extra_isize found in used inodes. Should not be lesser
506          * than s_min_extra_isize.
507          */
508         __u32 min_extra_isize;
509         int fs_unexpanded_inodes;
510         ext2fs_inode_bitmap expand_eisize_map;
511
512         /* Reserve blocks for root and l+f re-creation */
513         blk64_t root_repair_block, lnf_repair_block;
514
515         /*
516          * For the use of callers of the e2fsck functions; not used by
517          * e2fsck functions themselves.
518          */
519         void *priv_data;
520         ext2fs_block_bitmap block_metadata_map; /* Metadata blocks */
521
522         /* How much are we allowed to readahead? */
523         unsigned long long readahead_kb;
524
525         /*
526          * Inodes to rebuild extent trees
527          */
528         ext2fs_inode_bitmap inodes_to_rebuild;
529
530         /* Undo file */
531         char *undo_file;
532
533         /* Fast commit replay state */
534         struct e2fsck_fc_replay_state fc_replay_state;
535 #ifdef HAVE_PTHREAD
536         /* if @global_ctx is null, this field is unused */
537         struct e2fsck_thread     thread_info;
538         __u32                    pfs_num_threads;
539         __u32                    mmp_update_thread;
540         int                      fs_need_locking;
541         /* serialize fix operation for multiple threads */
542         pthread_rwlock_t         fs_fix_rwlock;
543         /* protect block_found_map, block_dup_map */
544         pthread_rwlock_t         fs_block_map_rwlock;
545         struct e2fsck_thread_info       *infos;
546 #endif
547 };
548
549 #ifdef HAVE_PTHREAD
550 #ifdef DEBUG_THREADS
551 /*
552  * Enabling DEBUG_THREADS would cause the parallel
553  * fsck threads run sequentially.
554  */
555 struct e2fsck_thread_debug {
556         pthread_mutex_t etd_mutex;
557         pthread_cond_t  etd_cond;
558         int             etd_finished_threads;
559 };
560 #endif
561
562 struct e2fsck_thread_info {
563         /* ID returned by pthread_create() */
564         pthread_t                eti_thread_id;
565         /* Application-defined thread index */
566         int                      eti_thread_index;
567         /* Thread has been started */
568         int                      eti_started;
569         /* Context used for this thread */
570         e2fsck_t                 eti_thread_ctx;
571 #ifdef DEBUG_THREADS
572         struct e2fsck_thread_debug      *eti_debug;
573 #endif
574 };
575
576 #endif
577
578 /* Data structures to evaluate whether an extent tree needs rebuilding. */
579 struct extent_tree_level {
580         unsigned int    num_extents;
581         unsigned int    max_extents;
582 };
583
584 struct extent_tree_info {
585         ext2_ino_t ino;
586         int force_rebuild;
587         struct extent_tree_level        ext_info[MAX_EXTENT_DEPTH_COUNT];
588 };
589
590 /* Used by the region allocation code */
591 typedef __u64 region_addr_t;
592 typedef struct region_struct *region_t;
593
594 #ifndef HAVE_STRNLEN
595 #define strnlen(str, x) e2fsck_strnlen((str),(x))
596 extern int e2fsck_strnlen(const char * s, int count);
597 #endif
598
599 /*
600  * Procedure declarations
601  */
602
603 extern void e2fsck_pass1(e2fsck_t ctx);
604 extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf);
605 extern void e2fsck_pass1_check_lock(e2fsck_t ctx);
606 extern void e2fsck_pass1_check_unlock(e2fsck_t ctx);
607 extern void e2fsck_pass2(e2fsck_t ctx);
608 extern void e2fsck_pass3(e2fsck_t ctx);
609 extern void e2fsck_pass4(e2fsck_t ctx);
610 extern void e2fsck_pass5(e2fsck_t ctx);
611
612 /* e2fsck.c */
613 extern errcode_t e2fsck_allocate_context(e2fsck_t *ret);
614 extern errcode_t e2fsck_reset_context(e2fsck_t ctx);
615 extern void e2fsck_free_context(e2fsck_t ctx);
616 extern int e2fsck_run(e2fsck_t ctx);
617
618
619 /* badblock.c */
620 extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
621                                  int replace_bad_blocks);
622
623 /* dirinfo.c */
624 extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent);
625 void e2fsck_merge_dir_info(e2fsck_t ctx, struct dir_info_db *src,
626                            struct dir_info_db *dest);
627 extern void e2fsck_free_dir_info(e2fsck_t ctx);
628 extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
629 extern struct dir_info_iter *e2fsck_dir_info_iter_begin(e2fsck_t ctx);
630 extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx,
631                                              struct dir_info_iter *);
632 extern void e2fsck_dir_info_iter_end(e2fsck_t ctx, struct dir_info_iter *);
633 extern int e2fsck_dir_info_set_parent(e2fsck_t ctx, ext2_ino_t ino,
634                                       ext2_ino_t parent);
635 extern int e2fsck_dir_info_set_dotdot(e2fsck_t ctx, ext2_ino_t ino,
636                                       ext2_ino_t dotdot);
637 extern int e2fsck_dir_info_get_parent(e2fsck_t ctx, ext2_ino_t ino,
638                                       ext2_ino_t *parent);
639 extern int e2fsck_dir_info_get_dotdot(e2fsck_t ctx, ext2_ino_t ino,
640                                       ext2_ino_t *dotdot);
641 extern void e2fsck_merge_dx_dir(e2fsck_t global_ctx, e2fsck_t thread_ctx);
642
643 /* dx_dirinfo.c */
644 extern void e2fsck_add_dx_dir(e2fsck_t ctx, ext2_ino_t ino,
645                               struct ext2_inode *inode, int num_blocks);
646 extern struct dx_dir_info *e2fsck_get_dx_dir_info(e2fsck_t ctx, ext2_ino_t ino);
647 extern void e2fsck_free_dx_dir_info(e2fsck_t ctx);
648 extern ext2_ino_t e2fsck_get_num_dx_dirinfo(e2fsck_t ctx);
649 extern struct dx_dir_info *e2fsck_dx_dir_info_iter(e2fsck_t ctx,
650                                                    ext2_ino_t *control);
651
652 /* ea_refcount.c */
653 typedef __u64 ea_key_t;
654 typedef __u64 ea_value_t;
655
656 extern errcode_t ea_refcount_create(size_t size, ext2_refcount_t *ret);
657 extern void ea_refcount_free(ext2_refcount_t refcount);
658 extern errcode_t ea_refcount_fetch(ext2_refcount_t refcount, ea_key_t ea_key,
659                                    ea_value_t *ret);
660 extern errcode_t ea_refcount_increment(ext2_refcount_t refcount,
661                                        ea_key_t ea_key, ea_value_t *ret);
662 extern errcode_t ea_refcount_decrement(ext2_refcount_t refcount,
663                                        ea_key_t ea_key, ea_value_t *ret);
664 extern errcode_t ea_refcount_store(ext2_refcount_t refcount, ea_key_t ea_key,
665                                    ea_value_t count);
666 extern size_t ext2fs_get_refcount_size(ext2_refcount_t refcount);
667 extern void ea_refcount_intr_begin(ext2_refcount_t refcount);
668 extern ea_key_t ea_refcount_intr_next(ext2_refcount_t refcount,
669                                       ea_value_t *ret);
670
671 /* ehandler.c */
672 extern const char *ehandler_operation(const char *op);
673 extern void ehandler_init(io_channel channel);
674
675 /* encrypted_files.c */
676
677 struct problem_context;
678 int add_encrypted_file(e2fsck_t ctx, struct problem_context *pctx);
679
680 #define NO_ENCRYPTION_POLICY            ((__u32)-1)
681 #define CORRUPT_ENCRYPTION_POLICY       ((__u32)-2)
682 #define UNRECOGNIZED_ENCRYPTION_POLICY  ((__u32)-3)
683 __u32 find_encryption_policy(e2fsck_t ctx, ext2_ino_t ino);
684
685 void destroy_encryption_policy_map(e2fsck_t ctx);
686 void destroy_encrypted_file_info(e2fsck_t ctx);
687
688 /* extents.c */
689 errcode_t e2fsck_rebuild_extents_later(e2fsck_t ctx, ext2_ino_t ino);
690 int e2fsck_ino_will_be_rebuilt(e2fsck_t ctx, ext2_ino_t ino);
691 void e2fsck_pass1e(e2fsck_t ctx);
692 errcode_t e2fsck_check_rebuild_extents(e2fsck_t ctx, ext2_ino_t ino,
693                                        struct ext2_inode *inode,
694                                        struct problem_context *pctx);
695 errcode_t e2fsck_should_rebuild_extents(e2fsck_t ctx,
696                                         struct problem_context *pctx,
697                                         struct extent_tree_info *eti,
698                                         struct ext2_extent_info *info);
699 errcode_t e2fsck_read_extents(e2fsck_t ctx, struct extent_list *extents);
700 errcode_t e2fsck_rewrite_extent_tree(e2fsck_t ctx,
701                                      struct extent_list *extents);
702
703 /* journal.c */
704 extern errcode_t e2fsck_check_ext3_journal(e2fsck_t ctx);
705 extern errcode_t e2fsck_run_ext3_journal(e2fsck_t ctx);
706 extern void e2fsck_move_ext3_journal(e2fsck_t ctx);
707 extern int e2fsck_fix_ext3_journal_hint(e2fsck_t ctx);
708
709 /* logfile.c */
710 extern void set_up_logging(e2fsck_t ctx);
711
712 /* quota.c */
713 extern void e2fsck_hide_quota(e2fsck_t ctx);
714 extern void e2fsck_validate_quota_inodes(e2fsck_t ctx);
715
716 /* pass1.c */
717 extern errcode_t e2fsck_setup_icount(e2fsck_t ctx, const char *icount_name,
718                                      int flags, ext2_icount_t hint,
719                                      ext2_icount_t *ret);
720 extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int use_shortcuts);
721 extern int e2fsck_pass1_check_device_inode(ext2_filsys fs,
722                                            struct ext2_inode *inode);
723 extern int e2fsck_pass1_check_symlink(e2fsck_t ctx, ext2_ino_t ino,
724                                       struct ext2_inode *inode, char *buf);
725 extern void e2fsck_clear_inode(e2fsck_t ctx, ext2_ino_t ino,
726                                struct ext2_inode *inode, int restart_flag,
727                                const char *source);
728 #define e2fsck_mark_inode_bad(ctx, pctx, code) \
729         e2fsck_mark_inode_bad_loc(ctx, pctx, code, 1, __func__, __LINE__)
730 #define e2fsck_mark_inode_badder(ctx, pctx, code) \
731         e2fsck_mark_inode_bad_loc(ctx, pctx, code, 2, __func__, __LINE__)
732 extern void e2fsck_mark_inode_bad_loc(e2fsck_t ctx,
733                                 struct problem_context *pctx, __u32 code,
734                                 int count, const char *func, const int line);
735 extern int e2fsck_fix_bad_inode(e2fsck_t ctx, struct problem_context *pctx);
736 extern void e2fsck_intercept_block_allocations(e2fsck_t ctx);
737
738 /* pass2.c */
739 extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir,
740                                     ext2_ino_t ino, char *buf);
741
742 /* pass3.c */
743 extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode);
744 extern errcode_t e2fsck_expand_directory(e2fsck_t ctx, ext2_ino_t dir,
745                                          int num, int gauranteed_size);
746 extern ext2_ino_t e2fsck_get_lost_and_found(e2fsck_t ctx, int fix);
747 extern errcode_t e2fsck_adjust_inode_count(e2fsck_t ctx, ext2_ino_t ino,
748                                            int adj);
749
750 /* readahead.c */
751 #define E2FSCK_READA_SUPER      (0x01)
752 #define E2FSCK_READA_GDT        (0x02)
753 #define E2FSCK_READA_BBITMAP    (0x04)
754 #define E2FSCK_READA_IBITMAP    (0x08)
755 #define E2FSCK_READA_ITABLE     (0x10)
756 #define E2FSCK_READA_ALL_FLAGS  (0x1F)
757 errcode_t e2fsck_readahead(ext2_filsys fs, int flags, dgrp_t start,
758                            dgrp_t ngroups);
759 #define E2FSCK_RA_DBLIST_IGNORE_BLOCKCNT        (0x01)
760 #define E2FSCK_RA_DBLIST_ALL_FLAGS              (0x01)
761 errcode_t e2fsck_readahead_dblist(ext2_filsys fs, int flags,
762                                   ext2_dblist dblist,
763                                   unsigned long long start,
764                                   unsigned long long count);
765 int e2fsck_can_readahead(ext2_filsys fs);
766 unsigned long long e2fsck_guess_readahead(ext2_filsys fs);
767
768 /* region.c */
769 extern region_t region_create(region_addr_t min, region_addr_t max);
770 extern void region_free(region_t region);
771 extern int region_allocate(region_t region, region_addr_t start, int n);
772
773 /* rehash.c */
774 void e2fsck_rehash_dir_later(e2fsck_t ctx, ext2_ino_t ino);
775 int e2fsck_dir_will_be_rehashed(e2fsck_t ctx, ext2_ino_t ino);
776 errcode_t e2fsck_rehash_dir(e2fsck_t ctx, ext2_ino_t ino,
777                             struct problem_context *pctx);
778 void e2fsck_rehash_directories(e2fsck_t ctx);
779
780 /* sigcatcher.c */
781 void sigcatcher_setup(void);
782
783 /* super.c */
784 void check_super_block(e2fsck_t ctx);
785 int check_backup_super_block(e2fsck_t ctx);
786 void check_resize_inode(e2fsck_t ctx);
787
788 /* util.c */
789 #define E2FSCK_MAX_THREADS      (65535)
790 extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned long size,
791                                     const char *description);
792 extern int ask(e2fsck_t ctx, const char * string, int def);
793 extern int ask_yn(e2fsck_t ctx, const char * string, int def);
794 extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
795 extern void log_out(e2fsck_t ctx, const char *fmt, ...)
796         E2FSCK_ATTR((format(printf, 2, 3)));
797 extern void log_err(e2fsck_t ctx, const char *fmt, ...)
798         E2FSCK_ATTR((format(printf, 2, 3)));
799 extern void e2fsck_read_bitmaps(e2fsck_t ctx);
800 extern void e2fsck_write_bitmaps(e2fsck_t ctx);
801 extern void preenhalt(e2fsck_t ctx);
802 extern char *string_copy(e2fsck_t ctx, const char *str, size_t len);
803 extern int fs_proc_check(const char *fs_name);
804 extern int check_for_modules(const char *fs_name);
805 #ifdef RESOURCE_TRACK
806 extern void print_resource_track(e2fsck_t ctx,
807                                  const char *desc,
808                                  struct resource_track *track,
809                                  io_channel channel);
810 extern void init_resource_track(struct resource_track *track,
811                                 io_channel channel);
812 #else
813 #define print_resource_track(ctx, desc, track, channel) do { } while (0)
814 #define init_resource_track(track, channel) do { } while (0)
815 #endif
816 extern int inode_has_valid_blocks(struct ext2_inode *inode);
817 extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
818                               struct ext2_inode * inode, const char * proc);
819 extern void e2fsck_read_inode_full(e2fsck_t ctx, unsigned long ino,
820                                    struct ext2_inode *inode,
821                                    const int bufsize, const char *proc);
822 extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
823                                struct ext2_inode * inode, const char * proc);
824 extern void e2fsck_write_inode_full(e2fsck_t ctx, unsigned long ino,
825                                struct ext2_inode * inode, int bufsize,
826                                const char *proc);
827 #ifdef MTRACE
828 extern void mtrace_print(char *mesg);
829 #endif
830 extern blk64_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs,
831                            const char *name, io_manager manager);
832 extern int ext2_file_type(unsigned int mode);
833 extern int write_all(int fd, char *buf, size_t count);
834 void dump_mmp_msg(struct mmp_struct *mmp, const char *fmt, ...)
835         E2FSCK_ATTR((format(printf, 2, 3)));
836 errcode_t e2fsck_mmp_update(ext2_filsys fs);
837
838 extern void e2fsck_set_bitmap_type(ext2_filsys fs,
839                                    unsigned int default_type,
840                                    const char *profile_name,
841                                    unsigned int *old_type);
842 extern errcode_t e2fsck_allocate_inode_bitmap(ext2_filsys fs,
843                                               const char *descr,
844                                               int default_type,
845                                               const char *profile_name,
846                                               ext2fs_inode_bitmap *ret);
847 extern errcode_t e2fsck_allocate_block_bitmap(ext2_filsys fs,
848                                               const char *descr,
849                                               int default_type,
850                                               const char *profile_name,
851                                               ext2fs_block_bitmap *ret);
852 extern errcode_t e2fsck_allocate_subcluster_bitmap(ext2_filsys fs,
853                                                    const char *descr,
854                                                    int default_type,
855                                                    const char *profile_name,
856                                                    ext2fs_block_bitmap *ret);
857 unsigned long long get_memory_size(void);
858 extern void e2fsck_pass1_fix_lock(e2fsck_t ctx);
859 extern void e2fsck_pass1_fix_unlock(e2fsck_t ctx);
860 extern void e2fsck_pass1_block_map_w_lock(e2fsck_t ctx);
861 extern void e2fsck_pass1_block_map_w_unlock(e2fsck_t ctx);
862 extern void e2fsck_pass1_block_map_r_lock(e2fsck_t ctx);
863 extern void e2fsck_pass1_block_map_r_unlock(e2fsck_t ctx);
864
865 /* unix.c */
866 extern void e2fsck_clear_progbar(e2fsck_t ctx);
867 extern int e2fsck_simple_progress(e2fsck_t ctx, const char *label,
868                                   float percent, unsigned int dpynum);
869
870 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
871
872 #endif /* _E2FSCK_H */