1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * Copyright (C) 2017 Oracle. All Rights Reserved.
4 * Author: Darrick J. Wong <darrick.wong@oracle.com>
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 void *buf;
81 uint ilock_flags;
82
83 /* See the XCHK/XREP state flags below. */
84 unsigned int flags;
85
86 /*
87 * The XFS_SICK_* flags that correspond to the metadata being scrubbed
88 * or repaired. We will use this mask to update the in-core fs health
89 * status with whatever we find.
90 */
91 unsigned int sick_mask;
92
93 /* State tracking for single-AG operations. */
94 struct xchk_ag sa;
95 };
96
97 /* XCHK state flags grow up from zero, XREP state flags grown down from 2^31 */
98 #define XCHK_TRY_HARDER (1 << 0) /* can't get resources, try again */
99 #define XCHK_REAPING_DISABLED (1 << 2) /* background block reaping paused */
100 #define XREP_ALREADY_FIXED (1 << 31) /* checking our repair work */
101
102 /* Metadata scrubbers */
103 int xchk_tester(struct xfs_scrub *sc);
104 int xchk_superblock(struct xfs_scrub *sc);
105 int xchk_agf(struct xfs_scrub *sc);
106 int xchk_agfl(struct xfs_scrub *sc);
107 int xchk_agi(struct xfs_scrub *sc);
108 int xchk_bnobt(struct xfs_scrub *sc);
109 int xchk_cntbt(struct xfs_scrub *sc);
110 int xchk_inobt(struct xfs_scrub *sc);
111 int xchk_finobt(struct xfs_scrub *sc);
112 int xchk_rmapbt(struct xfs_scrub *sc);
113 int xchk_refcountbt(struct xfs_scrub *sc);
114 int xchk_inode(struct xfs_scrub *sc);
115 int xchk_bmap_data(struct xfs_scrub *sc);
116 int xchk_bmap_attr(struct xfs_scrub *sc);
117 int xchk_bmap_cow(struct xfs_scrub *sc);
118 int xchk_directory(struct xfs_scrub *sc);
119 int xchk_xattr(struct xfs_scrub *sc);
120 int xchk_symlink(struct xfs_scrub *sc);
121 int xchk_parent(struct xfs_scrub *sc);
122 #ifdef CONFIG_XFS_RT
123 int xchk_rtbitmap(struct xfs_scrub *sc);
124 int xchk_rtsummary(struct xfs_scrub *sc);
125 #else
126 static inline int
xchk_rtbitmap(struct xfs_scrub * sc)127 xchk_rtbitmap(struct xfs_scrub *sc)
128 {
129 return -ENOENT;
130 }
131 static inline int
xchk_rtsummary(struct xfs_scrub * sc)132 xchk_rtsummary(struct xfs_scrub *sc)
133 {
134 return -ENOENT;
135 }
136 #endif
137 #ifdef CONFIG_XFS_QUOTA
138 int xchk_quota(struct xfs_scrub *sc);
139 #else
140 static inline int
xchk_quota(struct xfs_scrub * sc)141 xchk_quota(struct xfs_scrub *sc)
142 {
143 return -ENOENT;
144 }
145 #endif
146 int xchk_fscounters(struct xfs_scrub *sc);
147
148 /* cross-referencing helpers */
149 void xchk_xref_is_used_space(struct xfs_scrub *sc, xfs_agblock_t agbno,
150 xfs_extlen_t len);
151 void xchk_xref_is_not_inode_chunk(struct xfs_scrub *sc, xfs_agblock_t agbno,
152 xfs_extlen_t len);
153 void xchk_xref_is_inode_chunk(struct xfs_scrub *sc, xfs_agblock_t agbno,
154 xfs_extlen_t len);
155 void xchk_xref_is_owned_by(struct xfs_scrub *sc, xfs_agblock_t agbno,
156 xfs_extlen_t len, const struct xfs_owner_info *oinfo);
157 void xchk_xref_is_not_owned_by(struct xfs_scrub *sc, xfs_agblock_t agbno,
158 xfs_extlen_t len, const struct xfs_owner_info *oinfo);
159 void xchk_xref_has_no_owner(struct xfs_scrub *sc, xfs_agblock_t agbno,
160 xfs_extlen_t len);
161 void xchk_xref_is_cow_staging(struct xfs_scrub *sc, xfs_agblock_t bno,
162 xfs_extlen_t len);
163 void xchk_xref_is_not_shared(struct xfs_scrub *sc, xfs_agblock_t bno,
164 xfs_extlen_t len);
165 #ifdef CONFIG_XFS_RT
166 void xchk_xref_is_used_rt_space(struct xfs_scrub *sc, xfs_rtblock_t rtbno,
167 xfs_extlen_t len);
168 #else
169 # define xchk_xref_is_used_rt_space(sc, rtbno, len) do { } while (0)
170 #endif
171
172 #endif /* __XFS_SCRUB_SCRUB_H__ */
173