git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/error.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _BCACHEFS_ERROR_H
   3 #define _BCACHEFS_ERROR_H
   4
   5 #include <linux/list.h>
   6 #include <linux/printk.h>
   7
   8 struct bch_dev;
   9 struct bch_fs;
  10 struct work_struct;
  11
  12 /*
  13  * XXX: separate out errors that indicate on disk data is inconsistent, and flag
  14  * superblock as such
  15  */
  16
  17 /* Error messages: */
  18
  19 /*
  20  * Inconsistency errors: The on disk data is inconsistent. If these occur during
  21  * initial recovery, they don't indicate a bug in the running code - we walk all
  22  * the metadata before modifying anything. If they occur at runtime, they
  23  * indicate either a bug in the running code or (less likely) data is being
  24  * silently corrupted under us.
  25  *
  26  * XXX: audit all inconsistent errors and make sure they're all recoverable, in
  27  * BCH_ON_ERROR_CONTINUE mode
  28  */
  29
  30 bool bch2_inconsistent_error(struct bch_fs *);
  31
  32 void bch2_topology_error(struct bch_fs *);
  33
  34 #define bch2_fs_inconsistent(c, ...)                                    \
  35 ({                                                                      \
  36         bch_err(c, __VA_ARGS__);                                        \
  37         bch2_inconsistent_error(c);                                     \
  38 })
  39
  40 #define bch2_fs_inconsistent_on(cond, c, ...)                           \
  41 ({                                                                      \
  42         bool _ret = unlikely(!!(cond));                                 \
  43                                                                         \
  44         if (_ret)                                                       \
  45                 bch2_fs_inconsistent(c, __VA_ARGS__);                   \
  46         _ret;                                                           \
  47 })
  48
  49 /*
  50  * Later we might want to mark only the particular device inconsistent, not the
  51  * entire filesystem:
  52  */
  53
  54 #define bch2_dev_inconsistent(ca, ...)                                  \
  55 do {                                                                    \
  56         bch_err(ca, __VA_ARGS__);                                       \
  57         bch2_inconsistent_error((ca)->fs);                              \
  58 } while (0)
  59
  60 #define bch2_dev_inconsistent_on(cond, ca, ...)                         \
  61 ({                                                                      \
  62         bool _ret = unlikely(!!(cond));                                 \
  63                                                                         \
  64         if (_ret)                                                       \
  65                 bch2_dev_inconsistent(ca, __VA_ARGS__);                 \
  66         _ret;                                                           \
  67 })
  68
  69 /*
  70  * When a transaction update discovers or is causing a fs inconsistency, it's
  71  * helpful to also dump the pending updates:
  72  */
  73 #define bch2_trans_inconsistent(trans, ...)                             \
  74 ({                                                                      \
  75         bch_err(trans->c, __VA_ARGS__);                                 \
  76         bch2_inconsistent_error(trans->c);                              \
  77         bch2_dump_trans_updates(trans);                                 \
  78 })
  79
  80 #define bch2_trans_inconsistent_on(cond, trans, ...)                    \
  81 ({                                                                      \
  82         bool _ret = unlikely(!!(cond));                                 \
  83                                                                         \
  84         if (_ret)                                                       \
  85                 bch2_trans_inconsistent(trans, __VA_ARGS__);            \
  86         _ret;                                                           \
  87 })
  88
  89 /*
  90  * Fsck errors: inconsistency errors we detect at mount time, and should ideally
  91  * be able to repair:
  92  */
  93
  94 enum {
  95         BCH_FSCK_OK                     = 0,
  96         BCH_FSCK_ERRORS_NOT_FIXED       = 1,
  97         BCH_FSCK_REPAIR_UNIMPLEMENTED   = 2,
  98         BCH_FSCK_REPAIR_IMPOSSIBLE      = 3,
  99         BCH_FSCK_UNKNOWN_VERSION        = 4,
 100 };
 101
 102 enum fsck_err_opts {
 103         FSCK_OPT_EXIT,
 104         FSCK_OPT_YES,
 105         FSCK_OPT_NO,
 106         FSCK_OPT_ASK,
 107 };
 108
 109 enum fsck_err_ret {
 110         FSCK_ERR_IGNORE = 0,
 111         FSCK_ERR_FIX    = 1,
 112         FSCK_ERR_EXIT   = 2,
 113         FSCK_ERR_START_TOPOLOGY_REPAIR = 3,
 114 };
 115
 116 struct fsck_err_state {
 117         struct list_head        list;
 118         const char              *fmt;
 119         u64                     nr;
 120         bool                    ratelimited;
 121         char                    buf[512];
 122 };
 123
 124 #define FSCK_CAN_FIX            (1 << 0)
 125 #define FSCK_CAN_IGNORE         (1 << 1)
 126 #define FSCK_NEED_FSCK          (1 << 2)
 127 #define FSCK_NO_RATELIMIT       (1 << 3)
 128
 129 __printf(3, 4) __cold
 130 enum fsck_err_ret bch2_fsck_err(struct bch_fs *,
 131                                 unsigned, const char *, ...);
 132 void bch2_flush_fsck_errs(struct bch_fs *);
 133
 134 #define __fsck_err(c, _flags, msg, ...)                                 \
 135 ({                                                                      \
 136         int _fix = bch2_fsck_err(c, _flags, msg, ##__VA_ARGS__);\
 137                                                                         \
 138         if (_fix == FSCK_ERR_EXIT) {                                    \
 139                 bch_err(c, "Unable to continue, halting");              \
 140                 ret = BCH_FSCK_ERRORS_NOT_FIXED;                        \
 141                 goto fsck_err;                                          \
 142         }                                                               \
 143                                                                         \
 144         _fix;                                                           \
 145 })
 146
 147 /* These macros return true if error should be fixed: */
 148
 149 /* XXX: mark in superblock that filesystem contains errors, if we ignore: */
 150
 151 #define __fsck_err_on(cond, c, _flags, ...)                             \
 152         (unlikely(cond) ? __fsck_err(c, _flags, ##__VA_ARGS__) : false)
 153
 154 #define need_fsck_err_on(cond, c, ...)                                  \
 155         __fsck_err_on(cond, c, FSCK_CAN_IGNORE|FSCK_NEED_FSCK, ##__VA_ARGS__)
 156
 157 #define need_fsck_err(c, ...)                                           \
 158         __fsck_err(c, FSCK_CAN_IGNORE|FSCK_NEED_FSCK, ##__VA_ARGS__)
 159
 160 #define mustfix_fsck_err(c, ...)                                        \
 161         __fsck_err(c, FSCK_CAN_FIX, ##__VA_ARGS__)
 162
 163 #define mustfix_fsck_err_on(cond, c, ...)                               \
 164         __fsck_err_on(cond, c, FSCK_CAN_FIX, ##__VA_ARGS__)
 165
 166 #define fsck_err(c, ...)                                                \
 167         __fsck_err(c, FSCK_CAN_FIX|FSCK_CAN_IGNORE, ##__VA_ARGS__)
 168
 169 #define fsck_err_on(cond, c, ...)                                       \
 170         __fsck_err_on(cond, c, FSCK_CAN_FIX|FSCK_CAN_IGNORE, ##__VA_ARGS__)
 171
 172 /*
 173  * Fatal errors: these don't indicate a bug, but we can't continue running in RW
 174  * mode - pretty much just due to metadata IO errors:
 175  */
 176
 177 void bch2_fatal_error(struct bch_fs *);
 178
 179 #define bch2_fs_fatal_error(c, ...)                                     \
 180 do {                                                                    \
 181         bch_err(c, __VA_ARGS__);                                        \
 182         bch2_fatal_error(c);                                            \
 183 } while (0)
 184
 185 #define bch2_fs_fatal_err_on(cond, c, ...)                              \
 186 ({                                                                      \
 187         bool _ret = unlikely(!!(cond));                                 \
 188                                                                         \
 189         if (_ret)                                                       \
 190                 bch2_fs_fatal_error(c, __VA_ARGS__);                    \
 191         _ret;                                                           \
 192 })
 193
 194 /*
 195  * IO errors: either recoverable metadata IO (because we have replicas), or data
 196  * IO - we need to log it and print out a message, but we don't (necessarily)
 197  * want to shut down the fs:
 198  */
 199
 200 void bch2_io_error_work(struct work_struct *);
 201
 202 /* Does the error handling without logging a message */
 203 void bch2_io_error(struct bch_dev *);
 204
 205 /* Logs message and handles the error: */
 206 #define bch2_dev_io_error(ca, fmt, ...)                                 \
 207 do {                                                                    \
 208         printk_ratelimited(KERN_ERR "bcachefs (%s): " fmt,              \
 209                 (ca)->name, ##__VA_ARGS__);                             \
 210         bch2_io_error(ca);                                              \
 211 } while (0)
 212
 213 #define bch2_dev_inum_io_error(ca, _inum, _offset, fmt, ...)            \
 214 do {                                                                    \
 215         printk_ratelimited(KERN_ERR "bcachefs (%s inum %llu offset %llu): " fmt,\
 216                 (ca)->name, (_inum), (_offset), ##__VA_ARGS__);         \
 217         bch2_io_error(ca);                                              \
 218 } while (0)
 219
 220 #define bch2_dev_io_err_on(cond, ca, ...)                               \
 221 ({                                                                      \
 222         bool _ret = (cond);                                             \
 223                                                                         \
 224         if (_ret)                                                       \
 225                 bch2_dev_io_error(ca, __VA_ARGS__);                     \
 226         _ret;                                                           \
 227 })
 228
 229 #define bch2_dev_inum_io_err_on(cond, ca, _inum, _offset, ...)          \
 230 ({                                                                      \
 231         bool _ret = (cond);                                             \
 232                                                                         \
 233         if (_ret)                                                       \
 234                 bch2_dev_inum_io_error(ca, _inum, _offset, __VA_ARGS__);\
 235         _ret;                                                           \
 236 })
 237
 238 #endif /* _BCACHEFS_ERROR_H */