fs/xfs/scrub/scrub.h

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  * Copyright (C) 2017-2023 Oracle.  All Rights Reserved.
   4  * Author: Darrick J. Wong <[email protected]>
   5  */
   6 #ifndef __XFS_SCRUB_SCRUB_H__
   7 #define __XFS_SCRUB_SCRUB_H__
   8
   9 struct xfs_scrub;
  10
  11 /*
  12  * Standard flags for allocating memory within scrub.  NOFS context is
  13  * configured by the process allocation scope.  Scrub and repair must be able
  14  * to back out gracefully if there isn't enough memory.  Force-cast to avoid
  15  * complaints from static checkers.
  16  */
  17 #define XCHK_GFP_FLAGS  ((__force gfp_t)(GFP_KERNEL | __GFP_NOWARN | \
  18                                          __GFP_RETRY_MAYFAIL))
  19
  20 /* Type info and names for the scrub types. */
  21 enum xchk_type {
  22         ST_NONE = 1,    /* disabled */
  23         ST_PERAG,       /* per-AG metadata */
  24         ST_FS,          /* per-FS metadata */
  25         ST_INODE,       /* per-inode metadata */
  26 };
  27
  28 struct xchk_meta_ops {
  29         /* Acquire whatever resources are needed for the operation. */
  30         int             (*setup)(struct xfs_scrub *sc);
  31
  32         /* Examine metadata for errors. */
  33         int             (*scrub)(struct xfs_scrub *);
  34
  35         /* Repair or optimize the metadata. */
  36         int             (*repair)(struct xfs_scrub *);
  37
  38         /* Decide if we even have this piece of metadata. */
  39         bool            (*has)(struct xfs_mount *);
  40
  41         /* type describing required/allowed inputs */
  42         enum xchk_type  type;
  43 };
  44
  45 /* Buffer pointers and btree cursors for an entire AG. */
  46 struct xchk_ag {
  47         struct xfs_perag        *pag;
  48
  49         /* AG btree roots */
  50         struct xfs_buf          *agf_bp;
  51         struct xfs_buf          *agi_bp;
  52
  53         /* AG btrees */
  54         struct xfs_btree_cur    *bno_cur;
  55         struct xfs_btree_cur    *cnt_cur;
  56         struct xfs_btree_cur    *ino_cur;
  57         struct xfs_btree_cur    *fino_cur;
  58         struct xfs_btree_cur    *rmap_cur;
  59         struct xfs_btree_cur    *refc_cur;
  60 };
  61
  62 struct xfs_scrub {
  63         /* General scrub state. */
  64         struct xfs_mount                *mp;
  65         struct xfs_scrub_metadata       *sm;
  66         const struct xchk_meta_ops      *ops;
  67         struct xfs_trans                *tp;
  68
  69         /* File that scrub was called with. */
  70         struct file                     *file;
  71
  72         /*
  73          * File that is undergoing the scrub operation.  This can differ from
  74          * the file that scrub was called with if we're checking file-based fs
  75          * metadata (e.g. rt bitmaps) or if we're doing a scrub-by-handle for
  76          * something that can't be opened directly (e.g. symlinks).
  77          */
  78         struct xfs_inode                *ip;
  79
  80         /* Kernel memory buffer used by scrubbers; freed at teardown. */
  81         void                            *buf;
  82
  83         /*
  84          * Clean up resources owned by whatever is in the buffer.  Cleanup can
  85          * be deferred with this hook as a means for scrub functions to pass
  86          * data to repair functions.  This function must not free the buffer
  87          * itself.
  88          */
  89         void                            (*buf_cleanup)(void *buf);
  90
  91         /* xfile used by the scrubbers; freed at teardown. */
  92         struct xfile                    *xfile;
  93
  94         /* Lock flags for @ip. */
  95         uint                            ilock_flags;
  96
  97         /* See the XCHK/XREP state flags below. */
  98         unsigned int                    flags;
  99
 100         /*
 101          * The XFS_SICK_* flags that correspond to the metadata being scrubbed
 102          * or repaired.  We will use this mask to update the in-core fs health
 103          * status with whatever we find.
 104          */
 105         unsigned int                    sick_mask;
 106
 107         /* State tracking for single-AG operations. */
 108         struct xchk_ag                  sa;
 109 };
 110
 111 /* XCHK state flags grow up from zero, XREP state flags grown down from 2^31 */
 112 #define XCHK_TRY_HARDER         (1U << 0)  /* can't get resources, try again */
 113 #define XCHK_HAVE_FREEZE_PROT   (1U << 1)  /* do we have freeze protection? */
 114 #define XCHK_FSGATES_DRAIN      (1U << 2)  /* defer ops draining enabled */
 115 #define XCHK_NEED_DRAIN         (1U << 3)  /* scrub needs to drain defer ops */
 116 #define XREP_ALREADY_FIXED      (1U << 31) /* checking our repair work */
 117
 118 /*
 119  * The XCHK_FSGATES* flags reflect functionality in the main filesystem that
 120  * are only enabled for this particular online fsck.  When not in use, the
 121  * features are gated off via dynamic code patching, which is why the state
 122  * must be enabled during scrub setup and can only be torn down afterwards.
 123  */
 124 #define XCHK_FSGATES_ALL        (XCHK_FSGATES_DRAIN)
 125
 126 /* Metadata scrubbers */
 127 int xchk_tester(struct xfs_scrub *sc);
 128 int xchk_superblock(struct xfs_scrub *sc);
 129 int xchk_agf(struct xfs_scrub *sc);
 130 int xchk_agfl(struct xfs_scrub *sc);
 131 int xchk_agi(struct xfs_scrub *sc);
 132 int xchk_bnobt(struct xfs_scrub *sc);
 133 int xchk_cntbt(struct xfs_scrub *sc);
 134 int xchk_inobt(struct xfs_scrub *sc);
 135 int xchk_finobt(struct xfs_scrub *sc);
 136 int xchk_rmapbt(struct xfs_scrub *sc);
 137 int xchk_refcountbt(struct xfs_scrub *sc);
 138 int xchk_inode(struct xfs_scrub *sc);
 139 int xchk_bmap_data(struct xfs_scrub *sc);
 140 int xchk_bmap_attr(struct xfs_scrub *sc);
 141 int xchk_bmap_cow(struct xfs_scrub *sc);
 142 int xchk_directory(struct xfs_scrub *sc);
 143 int xchk_xattr(struct xfs_scrub *sc);
 144 int xchk_symlink(struct xfs_scrub *sc);
 145 int xchk_parent(struct xfs_scrub *sc);
 146 #ifdef CONFIG_XFS_RT
 147 int xchk_rtbitmap(struct xfs_scrub *sc);
 148 int xchk_rtsummary(struct xfs_scrub *sc);
 149 #else
 150 static inline int
 151 xchk_rtbitmap(struct xfs_scrub *sc)
 152 {
 153         return -ENOENT;
 154 }
 155 static inline int
 156 xchk_rtsummary(struct xfs_scrub *sc)
 157 {
 158         return -ENOENT;
 159 }
 160 #endif
 161 #ifdef CONFIG_XFS_QUOTA
 162 int xchk_quota(struct xfs_scrub *sc);
 163 #else
 164 static inline int
 165 xchk_quota(struct xfs_scrub *sc)
 166 {
 167         return -ENOENT;
 168 }
 169 #endif
 170 int xchk_fscounters(struct xfs_scrub *sc);
 171
 172 /* cross-referencing helpers */
 173 void xchk_xref_is_used_space(struct xfs_scrub *sc, xfs_agblock_t agbno,
 174                 xfs_extlen_t len);
 175 void xchk_xref_is_not_inode_chunk(struct xfs_scrub *sc, xfs_agblock_t agbno,
 176                 xfs_extlen_t len);
 177 void xchk_xref_is_inode_chunk(struct xfs_scrub *sc, xfs_agblock_t agbno,
 178                 xfs_extlen_t len);
 179 void xchk_xref_is_only_owned_by(struct xfs_scrub *sc, xfs_agblock_t agbno,
 180                 xfs_extlen_t len, const struct xfs_owner_info *oinfo);
 181 void xchk_xref_is_not_owned_by(struct xfs_scrub *sc, xfs_agblock_t agbno,
 182                 xfs_extlen_t len, const struct xfs_owner_info *oinfo);
 183 void xchk_xref_has_no_owner(struct xfs_scrub *sc, xfs_agblock_t agbno,
 184                 xfs_extlen_t len);
 185 void xchk_xref_is_cow_staging(struct xfs_scrub *sc, xfs_agblock_t bno,
 186                 xfs_extlen_t len);
 187 void xchk_xref_is_not_shared(struct xfs_scrub *sc, xfs_agblock_t bno,
 188                 xfs_extlen_t len);
 189 void xchk_xref_is_not_cow_staging(struct xfs_scrub *sc, xfs_agblock_t bno,
 190                 xfs_extlen_t len);
 191 #ifdef CONFIG_XFS_RT
 192 void xchk_xref_is_used_rt_space(struct xfs_scrub *sc, xfs_rtblock_t rtbno,
 193                 xfs_extlen_t len);
 194 #else
 195 # define xchk_xref_is_used_rt_space(sc, rtbno, len) do { } while (0)
 196 #endif
 197
 198 #endif  /* __XFS_SCRUB_SCRUB_H__ */