Whamcloud - gitweb
Merge branch 'maint' into next
[tools/e2fsprogs.git] / e2fsck / e2fsck.h
index 1071847..954bc98 100644 (file)
@@ -1,9 +1,9 @@
 /*
  * e2fsck.h
- * 
+ *
  * Copyright (C) 1993, 1994 Theodore Ts'o.  This file may be
  * redistributed under the terms of the GNU Public License.
- * 
+ *
  */
 
 #ifndef _E2FSCK_H
@@ -36,8 +36,8 @@
 #include "blkid/blkid.h"
 #endif
 
-#include "profile.h"
-#include "prof_err.h"
+#include "support/profile.h"
+#include "support/prof_err.h"
 
 #ifdef ENABLE_NLS
 #include <libintl.h>
 #define P_(singular, plural, n) ((n) == 1 ? (singular) : (plural))
 #endif
 
+#ifdef __GNUC__
+#define E2FSCK_ATTR(x) __attribute__(x)
+#else
+#define E2FSCK_ATTR(x)
+#endif
+
+#include "support/quotaio.h"
+
 /*
  * Exit codes used by fsck-type programs
  */
@@ -101,6 +109,7 @@ struct dx_dir_info {
        int                     hashversion;
        short                   depth;          /* depth of tree */
        struct dx_dirblock_info *dx_block;      /* Array of size numblocks */
+       int                     casefolded_hash;
 };
 
 #define DX_DIRBLOCK_ROOT       1
@@ -111,12 +120,13 @@ struct dx_dir_info {
 
 struct dx_dirblock_info {
        int             type;
-       blk_t           phys;
+       blk64_t         phys;
        int             flags;
-       blk_t           parent;
-       ext2_dirhash_t  min_hash; 
+       blk64_t         parent;
+       blk64_t         previous;
+       ext2_dirhash_t  min_hash;
        ext2_dirhash_t  max_hash;
-       ext2_dirhash_t  node_min_hash; 
+       ext2_dirhash_t  node_min_hash;
        ext2_dirhash_t  node_max_hash;
 };
 
@@ -125,6 +135,10 @@ struct dx_dirblock_info {
 #define DX_FLAG_FIRST          4
 #define DX_FLAG_LAST           8
 
+struct encrypted_file_info;
+
+#define RESOURCE_TRACK
+
 #ifdef RESOURCE_TRACK
 /*
  * This structure is used for keeping track of how much resources have
@@ -154,25 +168,41 @@ struct resource_track {
 #define E2F_OPT_FORCE          0x0100
 #define E2F_OPT_WRITECHECK     0x0200
 #define E2F_OPT_COMPRESS_DIRS  0x0400
+#define E2F_OPT_FRAGCHECK      0x0800
+#define E2F_OPT_JOURNAL_ONLY   0x1000 /* only replay the journal */
+#define E2F_OPT_DISCARD                0x2000
+#define E2F_OPT_CONVERT_BMAP   0x4000 /* convert blockmap to extent */
+#define E2F_OPT_FIXES_ONLY     0x8000 /* skip all optimizations */
+#define E2F_OPT_NOOPT_EXTENTS  0x10000 /* don't optimize extents */
+#define E2F_OPT_ICOUNT_FULLMAP 0x20000 /* use an array for inode counts */
+#define E2F_OPT_UNSHARE_BLOCKS  0x40000
+#define E2F_OPT_CLEAR_UNINIT   0x80000 /* Hack to clear the uninit bit */
 
 /*
  * E2fsck flags
  */
 #define E2F_FLAG_ABORT         0x0001 /* Abort signaled */
 #define E2F_FLAG_CANCEL                0x0002 /* Cancel signaled */
-#define E2F_FLAG_SIGNAL_MASK   0x0003
+#define E2F_FLAG_SIGNAL_MASK   (E2F_FLAG_ABORT | E2F_FLAG_CANCEL)
 #define E2F_FLAG_RESTART       0x0004 /* Restart signaled */
-
+#define E2F_FLAG_RUN_RETURN    (E2F_FLAG_SIGNAL_MASK | E2F_FLAG_RESTART)
+#define E2F_FLAG_RESTART_LATER 0x0008 /* Restart after all iterations done */
 #define E2F_FLAG_SETJMP_OK     0x0010 /* Setjmp valid for abort */
 
 #define E2F_FLAG_PROG_BAR      0x0020 /* Progress bar on screen */
 #define E2F_FLAG_PROG_SUPPRESS 0x0040 /* Progress suspended */
 #define E2F_FLAG_JOURNAL_INODE 0x0080 /* Create a new ext3 journal inode */
-#define E2F_FLAG_SB_SPECIFIED  0x0100 /* The superblock was explicitly 
+#define E2F_FLAG_SB_SPECIFIED  0x0100 /* The superblock was explicitly
                                        * specified by the user */
 #define E2F_FLAG_RESTARTED     0x0200 /* E2fsck has been restarted */
 #define E2F_FLAG_RESIZE_INODE  0x0400 /* Request to recreate resize inode */
 #define E2F_FLAG_GOT_DEVSIZE   0x0800 /* Device size has been fetched */
+#define E2F_FLAG_EXITING       0x1000 /* E2fsck exiting due to errors */
+#define E2F_FLAG_TIME_INSANE   0x2000 /* Time is insane */
+#define E2F_FLAG_PROBLEMS_FIXED        0x4000 /* At least one problem was fixed */
+#define E2F_FLAG_ALLOC_OK      0x8000 /* Can we allocate blocks? */
+
+#define E2F_RESET_FLAGS (E2F_FLAG_TIME_INSANE | E2F_FLAG_PROBLEMS_FIXED)
 
 /*
  * Defines for indicating the e2fsck pass number
@@ -194,19 +224,28 @@ typedef struct ea_refcount *ext2_refcount_t;
  */
 typedef struct e2fsck_struct *e2fsck_t;
 
+#define MAX_EXTENT_DEPTH_COUNT 5
+
 struct e2fsck_struct {
        ext2_filsys fs;
        const char *program_name;
        char *filesystem_name;
        char *device_name;
        char *io_options;
+       FILE    *logf;
+       char    *log_fn;
+       FILE    *problem_logf;
+       char    *problem_log_fn;
        int     flags;          /* E2fsck internal flags */
        int     options;
-       blk_t   use_superblock; /* sb requested by user */
-       blk_t   superblock;     /* sb used to open fs */
        int     blocksize;      /* blocksize */
-       blk_t   num_blocks;     /* Total number of blocks */
+       blk64_t use_superblock; /* sb requested by user */
+       blk64_t superblock;     /* sb used to open fs */
+       blk64_t num_blocks;     /* Total number of blocks */
+       blk64_t free_blocks;
+       ino_t   free_inodes;
        int     mount_flags;
+       int     openfs_flags;
        blkid_cache blkid;      /* blkid cache */
 
 #ifdef HAVE_SETJMP_H
@@ -238,6 +277,17 @@ struct e2fsck_struct {
        ext2_refcount_t refcount_extra;
 
        /*
+        * Quota blocks and inodes to be charged for each ea block.
+        */
+       ext2_refcount_t ea_block_quota_blocks;
+       ext2_refcount_t ea_block_quota_inodes;
+
+       /*
+        * ea_inode references from attr entries.
+        */
+       ext2_refcount_t ea_inode_refs;
+
+       /*
         * Array of flags indicating whether an inode bitmap, block
         * bitmap, or inode table is invalid
         */
@@ -262,7 +312,7 @@ struct e2fsck_struct {
         */
        ext2_ino_t lost_and_found;
        int bad_lost_and_found;
-       
+
        /*
         * Directory information
         */
@@ -281,10 +331,16 @@ struct e2fsck_struct {
        ext2_u32_list   dirs_to_hash;
 
        /*
+        * Encrypted file information
+        */
+       struct encrypted_file_info *encrypted_files;
+
+       /*
         * Tuning parameters
         */
        int process_inode_size;
        int inode_buffer_blocks;
+       unsigned int htree_slack_percentage;
 
        /*
         * ext3 journal support
@@ -292,6 +348,10 @@ struct e2fsck_struct {
        io_channel      journal_io;
        char    *journal_name;
 
+       /*
+        * Ext4 quota support
+        */
+       quota_ctx_t qctx;
 #ifdef RESOURCE_TRACK
        /*
         * For timing purposes
@@ -308,7 +368,7 @@ struct e2fsck_struct {
        unsigned int progress_last_time;
        int interactive;        /* Are we connected directly to a tty? */
        char start_meta[2], stop_meta[2];
-       
+
        /* File counts */
        __u32 fs_directory_count;
        __u32 fs_regular_count;
@@ -325,25 +385,55 @@ struct e2fsck_struct {
        __u32 fs_dind_count;
        __u32 fs_tind_count;
        __u32 fs_fragmented;
+       __u32 fs_fragmented_dir;
        __u32 large_files;
        __u32 fs_ext_attr_inodes;
        __u32 fs_ext_attr_blocks;
+       __u32 extent_depth_count[MAX_EXTENT_DEPTH_COUNT];
 
        /* misc fields */
        time_t now;
+       time_t time_fudge;      /* For working around buggy init scripts */
        int ext_attr_ver;
        profile_t       profile;
        int blocks_per_page;
 
+       /* Reserve blocks for root and l+f re-creation */
+       blk64_t root_repair_block, lnf_repair_block;
+
        /*
         * For the use of callers of the e2fsck functions; not used by
         * e2fsck functions themselves.
         */
        void *priv_data;
+       ext2fs_block_bitmap block_metadata_map; /* Metadata blocks */
+
+       /* How much are we allowed to readahead? */
+       unsigned long long readahead_kb;
+
+       /*
+        * Inodes to rebuild extent trees
+        */
+       ext2fs_inode_bitmap inodes_to_rebuild;
+
+       /* Undo file */
+       char *undo_file;
+};
+
+/* Data structures to evaluate whether an extent tree needs rebuilding. */
+struct extent_tree_level {
+       unsigned int    num_extents;
+       unsigned int    max_extents;
+};
+
+struct extent_tree_info {
+       ext2_ino_t ino;
+       int force_rebuild;
+       struct extent_tree_level        ext_info[MAX_EXTENT_DEPTH_COUNT];
 };
 
 /* Used by the region allocation code */
-typedef __u32 region_addr_t;
+typedef __u64 region_addr_t;
 typedef struct region_struct *region_t;
 
 #ifndef HAVE_STRNLEN
@@ -378,58 +468,100 @@ extern void e2fsck_add_dir_info(e2fsck_t ctx, ext2_ino_t ino, ext2_ino_t parent)
 extern void e2fsck_free_dir_info(e2fsck_t ctx);
 extern int e2fsck_get_num_dirinfo(e2fsck_t ctx);
 extern struct dir_info_iter *e2fsck_dir_info_iter_begin(e2fsck_t ctx);
-extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx, 
+extern struct dir_info *e2fsck_dir_info_iter(e2fsck_t ctx,
                                             struct dir_info_iter *);
 extern void e2fsck_dir_info_iter_end(e2fsck_t ctx, struct dir_info_iter *);
-extern int e2fsck_dir_info_set_parent(e2fsck_t ctx, ext2_ino_t ino, 
+extern int e2fsck_dir_info_set_parent(e2fsck_t ctx, ext2_ino_t ino,
                                      ext2_ino_t parent);
-extern int e2fsck_dir_info_set_dotdot(e2fsck_t ctx, ext2_ino_t ino, 
+extern int e2fsck_dir_info_set_dotdot(e2fsck_t ctx, ext2_ino_t ino,
                                      ext2_ino_t dotdot);
-extern int e2fsck_dir_info_get_parent(e2fsck_t ctx, ext2_ino_t ino, 
+extern int e2fsck_dir_info_get_parent(e2fsck_t ctx, ext2_ino_t ino,
                                      ext2_ino_t *parent);
-extern int e2fsck_dir_info_get_dotdot(e2fsck_t ctx, ext2_ino_t ino, 
+extern int e2fsck_dir_info_get_dotdot(e2fsck_t ctx, ext2_ino_t ino,
                                      ext2_ino_t *dotdot);
 
 /* dx_dirinfo.c */
-extern void e2fsck_add_dx_dir(e2fsck_t ctx, ext2_ino_t ino, int num_blocks);
+extern void e2fsck_add_dx_dir(e2fsck_t ctx, ext2_ino_t ino,
+                             struct ext2_inode *inode, int num_blocks);
 extern struct dx_dir_info *e2fsck_get_dx_dir_info(e2fsck_t ctx, ext2_ino_t ino);
 extern void e2fsck_free_dx_dir_info(e2fsck_t ctx);
 extern int e2fsck_get_num_dx_dirinfo(e2fsck_t ctx);
 extern struct dx_dir_info *e2fsck_dx_dir_info_iter(e2fsck_t ctx, int *control);
 
 /* ea_refcount.c */
-extern errcode_t ea_refcount_create(int size, ext2_refcount_t *ret);
+typedef __u64 ea_key_t;
+typedef __u64 ea_value_t;
+
+extern errcode_t ea_refcount_create(size_t size, ext2_refcount_t *ret);
 extern void ea_refcount_free(ext2_refcount_t refcount);
-extern errcode_t ea_refcount_fetch(ext2_refcount_t refcount, blk_t blk,
-                                  int *ret);
+extern errcode_t ea_refcount_fetch(ext2_refcount_t refcount, ea_key_t ea_key,
+                                  ea_value_t *ret);
 extern errcode_t ea_refcount_increment(ext2_refcount_t refcount,
-                                      blk_t blk, int *ret);
+                                      ea_key_t ea_key, ea_value_t *ret);
 extern errcode_t ea_refcount_decrement(ext2_refcount_t refcount,
-                                      blk_t blk, int *ret);
-extern errcode_t ea_refcount_store(ext2_refcount_t refcount,
-                                  blk_t blk, int count);
-extern blk_t ext2fs_get_refcount_size(ext2_refcount_t refcount);
+                                      ea_key_t ea_key, ea_value_t *ret);
+extern errcode_t ea_refcount_store(ext2_refcount_t refcount, ea_key_t ea_key,
+                                  ea_value_t count);
+extern size_t ext2fs_get_refcount_size(ext2_refcount_t refcount);
 extern void ea_refcount_intr_begin(ext2_refcount_t refcount);
-extern blk_t ea_refcount_intr_next(ext2_refcount_t refcount, int *ret);
+extern ea_key_t ea_refcount_intr_next(ext2_refcount_t refcount,
+                                     ea_value_t *ret);
 
 /* ehandler.c */
 extern const char *ehandler_operation(const char *op);
 extern void ehandler_init(io_channel channel);
 
+/* encrypted_files.c */
+
+struct problem_context;
+int add_encrypted_file(e2fsck_t ctx, struct problem_context *pctx);
+
+#define NO_ENCRYPTION_POLICY           ((__u32)-1)
+#define CORRUPT_ENCRYPTION_POLICY      ((__u32)-2)
+#define UNRECOGNIZED_ENCRYPTION_POLICY ((__u32)-3)
+__u32 find_encryption_policy(e2fsck_t ctx, ext2_ino_t ino);
+
+void destroy_encryption_policy_map(e2fsck_t ctx);
+void destroy_encrypted_file_info(e2fsck_t ctx);
+
+/* extents.c */
+errcode_t e2fsck_rebuild_extents_later(e2fsck_t ctx, ext2_ino_t ino);
+int e2fsck_ino_will_be_rebuilt(e2fsck_t ctx, ext2_ino_t ino);
+void e2fsck_pass1e(e2fsck_t ctx);
+errcode_t e2fsck_check_rebuild_extents(e2fsck_t ctx, ext2_ino_t ino,
+                                      struct ext2_inode *inode,
+                                      struct problem_context *pctx);
+errcode_t e2fsck_should_rebuild_extents(e2fsck_t ctx,
+                                       struct problem_context *pctx,
+                                       struct extent_tree_info *eti,
+                                       struct ext2_extent_info *info);
+
 /* journal.c */
-extern int e2fsck_check_ext3_journal(e2fsck_t ctx);
-extern int e2fsck_run_ext3_journal(e2fsck_t ctx);
+extern errcode_t e2fsck_check_ext3_journal(e2fsck_t ctx);
+extern errcode_t e2fsck_run_ext3_journal(e2fsck_t ctx);
 extern void e2fsck_move_ext3_journal(e2fsck_t ctx);
 extern int e2fsck_fix_ext3_journal_hint(e2fsck_t ctx);
 
+/* logfile.c */
+extern void set_up_logging(e2fsck_t ctx);
+
+/* quota.c */
+extern void e2fsck_hide_quota(e2fsck_t ctx);
+extern void e2fsck_validate_quota_inodes(e2fsck_t ctx);
+
 /* pass1.c */
-extern void e2fsck_setup_tdb_icount(e2fsck_t ctx, int flags, 
-                                   ext2_icount_t *ret);
-extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int bool);
+extern errcode_t e2fsck_setup_icount(e2fsck_t ctx, const char *icount_name,
+                                    int flags, ext2_icount_t hint,
+                                    ext2_icount_t *ret);
+extern void e2fsck_use_inode_shortcuts(e2fsck_t ctx, int use_shortcuts);
 extern int e2fsck_pass1_check_device_inode(ext2_filsys fs,
                                           struct ext2_inode *inode);
-extern int e2fsck_pass1_check_symlink(ext2_filsys fs,
+extern int e2fsck_pass1_check_symlink(ext2_filsys fs, ext2_ino_t ino,
                                      struct ext2_inode *inode, char *buf);
+extern void e2fsck_clear_inode(e2fsck_t ctx, ext2_ino_t ino,
+                              struct ext2_inode *inode, int restart_flag,
+                              const char *source);
+extern void e2fsck_intercept_block_allocations(e2fsck_t ctx);
 
 /* pass2.c */
 extern int e2fsck_process_bad_inode(e2fsck_t ctx, ext2_ino_t dir,
@@ -440,9 +572,26 @@ extern int e2fsck_reconnect_file(e2fsck_t ctx, ext2_ino_t inode);
 extern errcode_t e2fsck_expand_directory(e2fsck_t ctx, ext2_ino_t dir,
                                         int num, int gauranteed_size);
 extern ext2_ino_t e2fsck_get_lost_and_found(e2fsck_t ctx, int fix);
-extern errcode_t e2fsck_adjust_inode_count(e2fsck_t ctx, ext2_ino_t ino, 
+extern errcode_t e2fsck_adjust_inode_count(e2fsck_t ctx, ext2_ino_t ino,
                                           int adj);
 
+/* readahead.c */
+#define E2FSCK_READA_SUPER     (0x01)
+#define E2FSCK_READA_GDT       (0x02)
+#define E2FSCK_READA_BBITMAP   (0x04)
+#define E2FSCK_READA_IBITMAP   (0x08)
+#define E2FSCK_READA_ITABLE    (0x10)
+#define E2FSCK_READA_ALL_FLAGS (0x1F)
+errcode_t e2fsck_readahead(ext2_filsys fs, int flags, dgrp_t start,
+                          dgrp_t ngroups);
+#define E2FSCK_RA_DBLIST_IGNORE_BLOCKCNT       (0x01)
+#define E2FSCK_RA_DBLIST_ALL_FLAGS             (0x01)
+errcode_t e2fsck_readahead_dblist(ext2_filsys fs, int flags,
+                                 ext2_dblist dblist,
+                                 unsigned long long start,
+                                 unsigned long long count);
+int e2fsck_can_readahead(ext2_filsys fs);
+unsigned long long e2fsck_guess_readahead(ext2_filsys fs);
 
 /* region.c */
 extern region_t region_create(region_addr_t min, region_addr_t max);
@@ -450,35 +599,53 @@ extern void region_free(region_t region);
 extern int region_allocate(region_t region, region_addr_t start, int n);
 
 /* rehash.c */
-errcode_t e2fsck_rehash_dir(e2fsck_t ctx, ext2_ino_t ino);
+void e2fsck_rehash_dir_later(e2fsck_t ctx, ext2_ino_t ino);
+int e2fsck_dir_will_be_rehashed(e2fsck_t ctx, ext2_ino_t ino);
+errcode_t e2fsck_rehash_dir(e2fsck_t ctx, ext2_ino_t ino,
+                           struct problem_context *pctx);
 void e2fsck_rehash_directories(e2fsck_t ctx);
 
+/* sigcatcher.c */
+void sigcatcher_setup(void);
+
 /* super.c */
 void check_super_block(e2fsck_t ctx);
-
-/* swapfs.c */
-void swap_filesys(e2fsck_t ctx);
+int check_backup_super_block(e2fsck_t ctx);
+void check_resize_inode(e2fsck_t ctx);
 
 /* util.c */
 extern void *e2fsck_allocate_memory(e2fsck_t ctx, unsigned int size,
                                    const char *description);
 extern int ask(e2fsck_t ctx, const char * string, int def);
-extern int ask_yn(const char * string, int def);
+extern int ask_yn(e2fsck_t ctx, const char * string, int def);
 extern void fatal_error(e2fsck_t ctx, const char * fmt_string);
+extern void log_out(e2fsck_t ctx, const char *fmt, ...)
+       E2FSCK_ATTR((format(printf, 2, 3)));
+extern void log_err(e2fsck_t ctx, const char *fmt, ...)
+       E2FSCK_ATTR((format(printf, 2, 3)));
 extern void e2fsck_read_bitmaps(e2fsck_t ctx);
 extern void e2fsck_write_bitmaps(e2fsck_t ctx);
 extern void preenhalt(e2fsck_t ctx);
 extern char *string_copy(e2fsck_t ctx, const char *str, int len);
+extern int fs_proc_check(const char *fs_name);
+extern int check_for_modules(const char *fs_name);
 #ifdef RESOURCE_TRACK
-extern void print_resource_track(const char *desc,
+extern void print_resource_track(e2fsck_t ctx,
+                                const char *desc,
                                 struct resource_track *track,
                                 io_channel channel);
 extern void init_resource_track(struct resource_track *track,
                                io_channel channel);
+#else
+#define print_resource_track(ctx, desc, track, channel) do { } while (0)
+#define init_resource_track(track, channel) do { } while (0)
 #endif
 extern int inode_has_valid_blocks(struct ext2_inode *inode);
 extern void e2fsck_read_inode(e2fsck_t ctx, unsigned long ino,
                              struct ext2_inode * inode, const char * proc);
+extern void e2fsck_read_inode_full(e2fsck_t ctx, unsigned long ino,
+                                  struct ext2_inode *inode,
+                                  const int bufsize, const char *proc);
 extern void e2fsck_write_inode(e2fsck_t ctx, unsigned long ino,
                               struct ext2_inode * inode, const char * proc);
 extern void e2fsck_write_inode_full(e2fsck_t ctx, unsigned long ino,
@@ -487,12 +654,40 @@ extern void e2fsck_write_inode_full(e2fsck_t ctx, unsigned long ino,
 #ifdef MTRACE
 extern void mtrace_print(char *mesg);
 #endif
-extern blk_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs,
+extern blk64_t get_backup_sb(e2fsck_t ctx, ext2_filsys fs,
                           const char *name, io_manager manager);
 extern int ext2_file_type(unsigned int mode);
+extern int write_all(int fd, char *buf, size_t count);
+void dump_mmp_msg(struct mmp_struct *mmp, const char *fmt, ...)
+       E2FSCK_ATTR((format(printf, 2, 3)));
+errcode_t e2fsck_mmp_update(ext2_filsys fs);
+
+extern void e2fsck_set_bitmap_type(ext2_filsys fs,
+                                  unsigned int default_type,
+                                  const char *profile_name,
+                                  unsigned int *old_type);
+extern errcode_t e2fsck_allocate_inode_bitmap(ext2_filsys fs,
+                                             const char *descr,
+                                             int default_type,
+                                             const char *profile_name,
+                                             ext2fs_inode_bitmap *ret);
+extern errcode_t e2fsck_allocate_block_bitmap(ext2_filsys fs,
+                                             const char *descr,
+                                             int default_type,
+                                             const char *profile_name,
+                                             ext2fs_block_bitmap *ret);
+extern errcode_t e2fsck_allocate_subcluster_bitmap(ext2_filsys fs,
+                                                  const char *descr,
+                                                  int default_type,
+                                                  const char *profile_name,
+                                                  ext2fs_block_bitmap *ret);
+unsigned long long get_memory_size(void);
 
 /* unix.c */
 extern void e2fsck_clear_progbar(e2fsck_t ctx);
 extern int e2fsck_simple_progress(e2fsck_t ctx, const char *label,
                                  float percent, unsigned int dpynum);
+
+#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
+
 #endif /* _E2FSCK_H */