1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * Copyright (C) 2017-2023 Oracle. All Rights Reserved. 4 * Author: Darrick J. Wong <djwong@kernel.org> 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 /* 39 * Re-scrub the metadata we repaired, in case there's extra work that 40 * we need to do to check our repair work. If this is NULL, we'll use 41 * the ->scrub function pointer, assuming that the regular scrub is 42 * sufficient. 43 */ 44 int (*repair_eval)(struct xfs_scrub *sc); 45 46 /* Decide if we even have this piece of metadata. */ 47 bool (*has)(struct xfs_mount *); 48 49 /* type describing required/allowed inputs */ 50 enum xchk_type type; 51 }; 52 53 /* Buffer pointers and btree cursors for an entire AG. */ 54 struct xchk_ag { 55 struct xfs_perag *pag; 56 57 /* AG btree roots */ 58 struct xfs_buf *agf_bp; 59 struct xfs_buf *agi_bp; 60 61 /* AG btrees */ 62 struct xfs_btree_cur *bno_cur; 63 struct xfs_btree_cur *cnt_cur; 64 struct xfs_btree_cur *ino_cur; 65 struct xfs_btree_cur *fino_cur; 66 struct xfs_btree_cur *rmap_cur; 67 struct xfs_btree_cur *refc_cur; 68 }; 69 70 struct xfs_scrub { 71 /* General scrub state. */ 72 struct xfs_mount *mp; 73 struct xfs_scrub_metadata *sm; 74 const struct xchk_meta_ops *ops; 75 struct xfs_trans *tp; 76 77 /* File that scrub was called with. */ 78 struct file *file; 79 80 /* 81 * File that is undergoing the scrub operation. This can differ from 82 * the file that scrub was called with if we're checking file-based fs 83 * metadata (e.g. rt bitmaps) or if we're doing a scrub-by-handle for 84 * something that can't be opened directly (e.g. symlinks). 85 */ 86 struct xfs_inode *ip; 87 88 /* Kernel memory buffer used by scrubbers; freed at teardown. */ 89 void *buf; 90 91 /* 92 * Clean up resources owned by whatever is in the buffer. Cleanup can 93 * be deferred with this hook as a means for scrub functions to pass 94 * data to repair functions. This function must not free the buffer 95 * itself. 96 */ 97 void (*buf_cleanup)(void *buf); 98 99 /* xfile used by the scrubbers; freed at teardown. */ 100 struct xfile *xfile; 101 102 /* buffer target for in-memory btrees; also freed at teardown. */ 103 struct xfs_buftarg *xmbtp; 104 105 /* Lock flags for @ip. */ 106 uint ilock_flags; 107 108 /* The orphanage, for stashing files that have lost their parent. */ 109 uint orphanage_ilock_flags; 110 struct xfs_inode *orphanage; 111 112 /* A temporary file on this filesystem, for staging new metadata. */ 113 struct xfs_inode *tempip; 114 uint temp_ilock_flags; 115 116 /* See the XCHK/XREP state flags below. */ 117 unsigned int flags; 118 119 /* 120 * The XFS_SICK_* flags that correspond to the metadata being scrubbed 121 * or repaired. We will use this mask to update the in-core fs health 122 * status with whatever we find. 123 */ 124 unsigned int sick_mask; 125 126 /* State tracking for single-AG operations. */ 127 struct xchk_ag sa; 128 }; 129 130 /* XCHK state flags grow up from zero, XREP state flags grown down from 2^31 */ 131 #define XCHK_TRY_HARDER (1U << 0) /* can't get resources, try again */ 132 #define XCHK_HAVE_FREEZE_PROT (1U << 1) /* do we have freeze protection? */ 133 #define XCHK_FSGATES_DRAIN (1U << 2) /* defer ops draining enabled */ 134 #define XCHK_NEED_DRAIN (1U << 3) /* scrub needs to drain defer ops */ 135 #define XCHK_FSGATES_QUOTA (1U << 4) /* quota live update enabled */ 136 #define XCHK_FSGATES_DIRENTS (1U << 5) /* directory live update enabled */ 137 #define XCHK_FSGATES_RMAP (1U << 6) /* rmapbt live update enabled */ 138 #define XREP_FSGATES_EXCHANGE_RANGE (1U << 29) /* uses file content exchange */ 139 #define XREP_RESET_PERAG_RESV (1U << 30) /* must reset AG space reservation */ 140 #define XREP_ALREADY_FIXED (1U << 31) /* checking our repair work */ 141 142 /* 143 * The XCHK_FSGATES* flags reflect functionality in the main filesystem that 144 * are only enabled for this particular online fsck. When not in use, the 145 * features are gated off via dynamic code patching, which is why the state 146 * must be enabled during scrub setup and can only be torn down afterwards. 147 */ 148 #define XCHK_FSGATES_ALL (XCHK_FSGATES_DRAIN | \ 149 XCHK_FSGATES_QUOTA | \ 150 XCHK_FSGATES_DIRENTS | \ 151 XCHK_FSGATES_RMAP) 152 153 /* 154 * The sole XREP_FSGATES* flag reflects a log intent item that is protected 155 * by a log-incompat feature flag. No code patching in use here. 156 */ 157 #define XREP_FSGATES_ALL (XREP_FSGATES_EXCHANGE_RANGE) 158 159 struct xfs_scrub_subord { 160 struct xfs_scrub sc; 161 struct xfs_scrub *parent_sc; 162 unsigned int old_smtype; 163 unsigned int old_smflags; 164 }; 165 166 struct xfs_scrub_subord *xchk_scrub_create_subord(struct xfs_scrub *sc, 167 unsigned int subtype); 168 void xchk_scrub_free_subord(struct xfs_scrub_subord *sub); 169 170 /* Metadata scrubbers */ 171 int xchk_tester(struct xfs_scrub *sc); 172 int xchk_superblock(struct xfs_scrub *sc); 173 int xchk_agf(struct xfs_scrub *sc); 174 int xchk_agfl(struct xfs_scrub *sc); 175 int xchk_agi(struct xfs_scrub *sc); 176 int xchk_allocbt(struct xfs_scrub *sc); 177 int xchk_iallocbt(struct xfs_scrub *sc); 178 int xchk_rmapbt(struct xfs_scrub *sc); 179 int xchk_refcountbt(struct xfs_scrub *sc); 180 int xchk_inode(struct xfs_scrub *sc); 181 int xchk_bmap_data(struct xfs_scrub *sc); 182 int xchk_bmap_attr(struct xfs_scrub *sc); 183 int xchk_bmap_cow(struct xfs_scrub *sc); 184 int xchk_directory(struct xfs_scrub *sc); 185 int xchk_xattr(struct xfs_scrub *sc); 186 int xchk_symlink(struct xfs_scrub *sc); 187 int xchk_parent(struct xfs_scrub *sc); 188 #ifdef CONFIG_XFS_RT 189 int xchk_rtbitmap(struct xfs_scrub *sc); 190 int xchk_rtsummary(struct xfs_scrub *sc); 191 #else 192 static inline int 193 xchk_rtbitmap(struct xfs_scrub *sc) 194 { 195 return -ENOENT; 196 } 197 static inline int 198 xchk_rtsummary(struct xfs_scrub *sc) 199 { 200 return -ENOENT; 201 } 202 #endif 203 #ifdef CONFIG_XFS_QUOTA 204 int xchk_quota(struct xfs_scrub *sc); 205 int xchk_quotacheck(struct xfs_scrub *sc); 206 #else 207 static inline int 208 xchk_quota(struct xfs_scrub *sc) 209 { 210 return -ENOENT; 211 } 212 static inline int 213 xchk_quotacheck(struct xfs_scrub *sc) 214 { 215 return -ENOENT; 216 } 217 #endif 218 int xchk_fscounters(struct xfs_scrub *sc); 219 int xchk_nlinks(struct xfs_scrub *sc); 220 221 /* cross-referencing helpers */ 222 void xchk_xref_is_used_space(struct xfs_scrub *sc, xfs_agblock_t agbno, 223 xfs_extlen_t len); 224 void xchk_xref_is_not_inode_chunk(struct xfs_scrub *sc, xfs_agblock_t agbno, 225 xfs_extlen_t len); 226 void xchk_xref_is_inode_chunk(struct xfs_scrub *sc, xfs_agblock_t agbno, 227 xfs_extlen_t len); 228 void xchk_xref_is_only_owned_by(struct xfs_scrub *sc, xfs_agblock_t agbno, 229 xfs_extlen_t len, const struct xfs_owner_info *oinfo); 230 void xchk_xref_is_not_owned_by(struct xfs_scrub *sc, xfs_agblock_t agbno, 231 xfs_extlen_t len, const struct xfs_owner_info *oinfo); 232 void xchk_xref_has_no_owner(struct xfs_scrub *sc, xfs_agblock_t agbno, 233 xfs_extlen_t len); 234 void xchk_xref_is_cow_staging(struct xfs_scrub *sc, xfs_agblock_t bno, 235 xfs_extlen_t len); 236 void xchk_xref_is_not_shared(struct xfs_scrub *sc, xfs_agblock_t bno, 237 xfs_extlen_t len); 238 void xchk_xref_is_not_cow_staging(struct xfs_scrub *sc, xfs_agblock_t bno, 239 xfs_extlen_t len); 240 #ifdef CONFIG_XFS_RT 241 void xchk_xref_is_used_rt_space(struct xfs_scrub *sc, xfs_rtblock_t rtbno, 242 xfs_extlen_t len); 243 #else 244 # define xchk_xref_is_used_rt_space(sc, rtbno, len) do { } while (0) 245 #endif 246 247 #endif /* __XFS_SCRUB_SCRUB_H__ */ 248