Whamcloud - gitweb
e2fsck: allow deleting or zeroing shared blocks
[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/mkquota.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         blk_t           phys;
123         int             flags;
124         blk_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
193 #define E2F_RESET_FLAGS (E2F_FLAG_TIME_INSANE)
194
195 /*
196  * Defines for indicating the e2fsck pass number
197  */
198 #define E2F_PASS_1      1
199 #define E2F_PASS_2      2
200 #define E2F_PASS_3      3
201 #define E2F_PASS_4      4
202 #define E2F_PASS_5      5
203 #define E2F_PASS_1B     6
204
205 enum shared_opt {
206         E2F_SHARED_PRESERVE = 0,
207         E2F_SHARED_DELETE,
208         E2F_SHARED_LPF
209 };
210
211 enum clone_opt {
212         E2F_CLONE_DUP = 0,
213         E2F_CLONE_ZERO
214 };
215
216 /*
217  * Define the extended attribute refcount structure
218  */
219 typedef struct ea_refcount *ext2_refcount_t;
220
221 /*
222  * This is the global e2fsck structure.
223  */
224 typedef struct e2fsck_struct *e2fsck_t;
225
226 #define MAX_EXTENT_DEPTH_COUNT 5
227
228 struct e2fsck_struct {
229         ext2_filsys fs;
230         const char *program_name;
231         char *filesystem_name;
232         char *device_name;
233         char *io_options;
234         FILE    *logf;
235         char    *log_fn;
236         int     flags;          /* E2fsck internal flags */
237         int     options;
238         int     blocksize;      /* blocksize */
239         blk64_t use_superblock; /* sb requested by user */
240         blk64_t superblock;     /* sb used to open fs */
241         blk64_t num_blocks;     /* Total number of blocks */
242         blk64_t free_blocks;
243         ino_t   free_inodes;
244         int     mount_flags;
245         blkid_cache blkid;      /* blkid cache */
246
247 #ifdef HAVE_SETJMP_H
248         jmp_buf abort_loc;
249 #endif
250         unsigned long abort_code;
251
252         int (*progress)(e2fsck_t ctx, int pass, unsigned long cur,
253                         unsigned long max);
254
255         ext2fs_inode_bitmap inode_used_map; /* Inodes which are in use */
256         ext2fs_inode_bitmap inode_bad_map; /* Inodes which are bad somehow */
257         ext2fs_inode_bitmap inode_dir_map; /* Inodes which are directories */
258         ext2fs_inode_bitmap inode_bb_map; /* Inodes which are in bad blocks */
259         ext2fs_inode_bitmap inode_imagic_map; /* AFS inodes */
260         ext2fs_inode_bitmap inode_reg_map; /* Inodes which are regular files*/
261
262         ext2fs_block_bitmap block_found_map; /* Blocks which are in use */
263         ext2fs_block_bitmap block_dup_map; /* Blks referenced more than once */
264         ext2fs_block_bitmap block_ea_map; /* Blocks which are used by EA's */
265
266         /*
267          * Inode count arrays
268          */
269         ext2_icount_t   inode_count;
270         ext2_icount_t inode_link_info;
271
272         ext2_refcount_t refcount;
273         ext2_refcount_t refcount_extra;
274
275         /*
276          * Array of flags indicating whether an inode bitmap, block
277          * bitmap, or inode table is invalid
278          */
279         int *invalid_inode_bitmap_flag;
280         int *invalid_block_bitmap_flag;
281         int *invalid_inode_table_flag;
282         int invalid_bitmaps;    /* There are invalid bitmaps/itable */
283
284         /*
285          * Block buffer
286          */
287         char *block_buf;
288
289         /*
290          * For pass1_check_directory and pass1_get_blocks
291          */
292         ext2_ino_t stashed_ino;
293         struct ext2_inode *stashed_inode;
294
295         /*
296          * Location of the lost and found directory
297          */
298         ext2_ino_t lost_and_found;
299         int bad_lost_and_found;
300
301         /*
302          * Directory information
303          */
304         struct dir_info_db      *dir_info;
305
306         /*
307          * Indexed directory information
308          */
309         int             dx_dir_info_count;
310         int             dx_dir_info_size;
311         struct dx_dir_info *dx_dir_info;
312
313         /*
314          * Directories to hash
315          */
316         ext2_u32_list   dirs_to_hash;
317
318         /*
319          * Tuning parameters
320          */
321         int process_inode_size;
322         int inode_buffer_blocks;
323         unsigned int htree_slack_percentage;
324
325         /*
326          * ext3 journal support
327          */
328         io_channel      journal_io;
329         char    *journal_name;
330
331         /*
332          * Ext4 quota support
333          */
334         quota_ctx_t qctx;
335 #ifdef RESOURCE_TRACK
336         /*
337          * For timing purposes
338          */
339         struct resource_track   global_rtrack;
340 #endif
341
342         /*
343          * How we display the progress update (for unix)
344          */
345         int progress_fd;
346         int progress_pos;
347         int progress_last_percent;
348         unsigned int progress_last_time;
349         int interactive;        /* Are we connected directly to a tty? */
350         char start_meta[2], stop_meta[2];
351
352         /* File counts */
353         __u32 fs_directory_count;
354         __u32 fs_regular_count;
355         __u32 fs_blockdev_count;
356         __u32 fs_chardev_count;
357         __u32 fs_links_count;
358         __u32 fs_symlinks_count;
359         __u32 fs_fast_symlinks_count;
360         __u32 fs_fifo_count;
361         __u32 fs_total_count;
362         __u32 fs_badblocks_count;
363         __u32 fs_sockets_count;
364         __u32 fs_ind_count;
365         __u32 fs_dind_count;
366         __u32 fs_tind_count;
367         __u32 fs_fragmented;
368         __u32 fs_fragmented_dir;
369         __u32 large_files;
370         __u32 fs_ext_attr_inodes;
371         __u32 fs_ext_attr_blocks;
372         __u32 extent_depth_count[MAX_EXTENT_DEPTH_COUNT];
373
374         /* misc fields */
375         time_t now;
376         time_t time_fudge;      /* For working around buggy init scripts */
377         int ext_attr_ver;
378         enum shared_opt shared;
379         enum clone_opt clone;
380         profile_t       profile;
381         int blocks_per_page;
382
383         /*
384          * For the use of callers of the e2fsck functions; not used by
385          * e2fsck functions themselves.
386          */
387         void *priv_data;
388 };
389
390 /* Used by the region allocation code */
391 typedef __u32 region_addr_t;
392 typedef struct region_struct *region_t;
393
394 #ifndef HAVE_STRNLEN
395 #define strnlen(str, x) e2fsck_strnlen((str),(x))
396 extern int e2fsck_strnlen(const char * s, int count);
397 #endif
398
399 /*
400  * Procedure declarations
401  */
402
403 extern void e2fsck_pass1(e2fsck_t ctx);
404 extern void e2fsck_pass1_dupblocks(e2fsck_t ctx, char *block_buf);
405 extern void e2fsck_pass2(e2fsck_t ctx);
406 extern void e2fsck_pass3(e2fsck_t ctx);
407 extern void e2fsck_pass4(e2fsck_t ctx);
408 extern void e2fsck_pass5(e2fsck_t ctx);
409
410 /* e2fsck.c */
411 extern errcode_t e2fsck_allocate_context(e2fsck_t *ret);
412 extern errcode_t e2fsck_reset_context(e2fsck_t ctx);
413 extern void e2fsck_free_context(e2fsck_t ctx);
414 extern int e2fsck_run(e2fsck_t ctx);
415
416
417 /* badblock.c */
418 extern void read_bad_blocks_file(e2fsck_t ctx, const char *bad_blocks_file,
419                                  int replace_bad_blocks);
420
421 /* crc32.c */
422 extern __u32 crc32_be(__u32 crc, unsigned char const *p, size_t len);
423
424 /* dirinfo.c */
425 extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent);
426 extern void e2fsck_free_dir_info(e2fsck_t ctx);
427 extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
428 extern struct dir_info_iter *e2fsck_dir_info_iter_begin(e2fsck_t ctx);
429 extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx,
430                                              struct dir_info_iter *);
431 extern void e2fsck_dir_info_iter_end(e2fsck_t ctx, struct dir_info_iter *);
432 extern int e2fsck_dir_info_set_parent(e2fsck_t ctx, ext2_ino_t ino,
433                                       ext2_ino_t parent);
434 extern int e2fsck_dir_info_set_dotdot(e2fsck_t ctx, ext2_ino_t ino,
435                                       ext2_ino_t dotdot);
436 extern int e2fsck_dir_info_get_parent(e2fsck_t ctx, ext2_ino_t ino,
437                                       ext2_ino_t *parent);
438 extern int e2fsck_dir_info_get_dotdot(e2fsck_t ctx, ext2_ino_t ino,
439                                       ext2_ino_t *dotdot);
440
441 /* dx_dirinfo.c */
442 extern void e2fsck_add_dx_dir(e2fsck_t ctx, ext2_ino_t ino, int num_blocks);
443 extern struct dx_dir_info *e2fsck_get_dx_dir_info(e2fsck_t ctx, ext2_ino_t ino);
444 extern void e2fsck_free_dx_dir_info(e2fsck_t ctx);
445 extern int e2fsck_get_num_dx_dirinfo(e2fsck_t ctx);
446 extern struct dx_dir_info *e2fsck_dx_dir_info_iter(e2fsck_t ctx, int *control);
447
448 /* ea_refcount.c */
449 extern errcode_t ea_refcount_create(int size, ext2_refcount_t *ret);
450 extern void ea_refcount_free(ext2_refcount_t refcount);
451 extern errcode_t ea_refcount_fetch(ext2_refcount_t refcount, blk_t blk,
452                                    int *ret);
453 extern errcode_t ea_refcount_increment(ext2_refcount_t refcount,
454                                        blk_t blk, int *ret);
455 extern errcode_t ea_refcount_decrement(ext2_refcount_t refcount,
456                                        blk_t blk, int *ret);
457 extern errcode_t ea_refcount_store(ext2_refcount_t refcount,
458                                    blk_t blk, int count);
459 extern blk_t ext2fs_get_refcount_size(ext2_refcount_t refcount);
460 extern void ea_refcount_intr_begin(ext2_refcount_t refcount);
461 extern blk_t ea_refcount_intr_next(ext2_refcount_t refcount, int *ret);
462
463 /* ehandler.c */
464 extern const char *ehandler_operation(const char *op);
465 extern void ehandler_init(io_channel channel);
466
467 /* journal.c */
468 extern int e2fsck_check_ext3_journal(e2fsck_t ctx);
469 extern int e2fsck_run_ext3_journal(e2fsck_t ctx);
470 extern void e2fsck_move_ext3_journal(e2fsck_t ctx);
471 extern int e2fsck_fix_ext3_journal_hint(e2fsck_t ctx);
472
473 /* logfile.c */
474 extern void set_up_logging(e2fsck_t ctx);
475
476 /* quota.c */
477 extern void e2fsck_hide_quota(e2fsck_t ctx);
478
479 /* pass1.c */
480 extern void e2fsck_setup_tdb_icount(e2fsck_t ctx, int flags,
481                                     ext2_icount_t *ret);
482 extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int bool);
483 extern int e2fsck_pass1_check_device_inode(ext2_filsys fs,
484                                            struct ext2_inode *inode);
485 extern int e2fsck_pass1_check_symlink(ext2_filsys fs, ext2_ino_t ino,
486                                       struct ext2_inode *inode, char *buf);
487 extern void e2fsck_clear_inode(e2fsck_t ctx, ext2_ino_t ino,
488                                struct ext2_inode *inode, int restart_flag,
489                                const char *source);
490
491 /* pass2.c */
492 extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir,
493                                     ext2_ino_t ino, char *buf);
494
495 /* pass3.c */
496 extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode);
497 extern errcode_t e2fsck_expand_directory(e2fsck_t ctx, ext2_ino_t dir,
498                                          int num, int gauranteed_size);
499 extern ext2_ino_t e2fsck_get_lost_and_found(e2fsck_t ctx, int fix);
500 extern errcode_t e2fsck_adjust_inode_count(e2fsck_t ctx, ext2_ino_t ino,
501                                            int adj);
502
503
504 /* region.c */
505 extern region_t region_create(region_addr_t min, region_addr_t max);
506 extern void region_free(region_t region);
507 extern int region_allocate(region_t region, region_addr_t start, int n);
508
509 /* rehash.c */
510 errcode_t e2fsck_rehash_dir(e2fsck_t ctx, ext2_ino_t ino);
511 void e2fsck_rehash_directories(e2fsck_t ctx);
512
513 /* sigcatcher.c */
514 void sigcatcher_setup(void);
515
516 /* super.c */
517 void check_super_block(e2fsck_t ctx);
518 int check_backup_super_block(e2fsck_t ctx);
519 void check_resize_inode(e2fsck_t ctx);
520
521 /* util.c */
522 extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
523                                     const char *description);
524 extern int ask(e2fsck_t ctx, const char * string, int def);
525 extern int ask_yn(e2fsck_t ctx, const char * string, int def);
526 extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
527 extern void log_out(e2fsck_t ctx, const char *fmt, ...)
528         E2FSCK_ATTR((format(printf, 2, 3)));
529 extern void log_err(e2fsck_t ctx, const char *fmt, ...)
530         E2FSCK_ATTR((format(printf, 2, 3)));
531 extern void e2fsck_read_bitmaps(e2fsck_t ctx);
532 extern void e2fsck_write_bitmaps(e2fsck_t ctx);
533 extern void preenhalt(e2fsck_t ctx);
534 extern char *string_copy(e2fsck_t ctx, const char *str, int len);
535 extern errcode_t e2fsck_zero_blocks(ext2_filsys fs, blk_t blk, int num,
536                                     blk_t *ret_blk, int *ret_count);
537 extern int fs_proc_check(const char *fs_name);
538 extern int check_for_modules(const char *fs_name);
539 #ifdef RESOURCE_TRACK
540 extern void print_resource_track(e2fsck_t ctx,
541                                  const char *desc,
542                                  struct resource_track *track,
543                                  io_channel channel);
544 extern void init_resource_track(struct resource_track *track,
545                                 io_channel channel);
546 #else
547 #define print_resource_track(ctx, desc, track, channel) do { } while (0)
548 #define init_resource_track(track, channel) do { } while (0)
549 #endif
550 extern int inode_has_valid_blocks(struct ext2_inode *inode);
551 extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
552                               struct ext2_inode * inode, const char * proc);
553 extern void e2fsck_read_inode_full(e2fsck_t ctx, unsigned long ino,
554                                    struct ext2_inode *inode,
555                                    const int bufsize, const char *proc);
556 extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
557                                struct ext2_inode * inode, const char * proc);
558 extern void e2fsck_write_inode_full(e2fsck_t ctx, unsigned long ino,
559                                struct ext2_inode * inode, int bufsize,
560                                const char *proc);
561 #ifdef MTRACE
562 extern void mtrace_print(char *mesg);
563 #endif
564 extern blk_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs,
565                            const char *name, io_manager manager);
566 extern int ext2_file_type(unsigned int mode);
567 extern int write_all(int fd, char *buf, size_t count);
568 void dump_mmp_msg(struct mmp_struct *mmp, const char *msg);
569 errcode_t e2fsck_mmp_update(ext2_filsys fs);
570
571 extern void e2fsck_set_bitmap_type(ext2_filsys fs,
572                                    unsigned int default_type,
573                                    const char *profile_name,
574                                    unsigned int *old_type);
575 extern errcode_t e2fsck_allocate_inode_bitmap(ext2_filsys fs,
576                                               const char *descr,
577                                               int default_type,
578                                               const char *profile_name,
579                                               ext2fs_inode_bitmap *ret);
580 extern errcode_t e2fsck_allocate_block_bitmap(ext2_filsys fs,
581                                               const char *descr,
582                                               int default_type,
583                                               const char *profile_name,
584                                               ext2fs_block_bitmap *ret);
585 extern errcode_t e2fsck_allocate_subcluster_bitmap(ext2_filsys fs,
586                                                    const char *descr,
587                                                    int default_type,
588                                                    const char *profile_name,
589                                                    ext2fs_block_bitmap *ret);
590
591 /* unix.c */
592 extern void e2fsck_clear_progbar(e2fsck_t ctx);
593 extern int e2fsck_simple_progress(e2fsck_t ctx, const char *label,
594                                   float percent, unsigned int dpynum);
595 #endif /* _E2FSCK_H */