xref: /linux/fs/xfs/scrub/repair.h (revision 1e58a8ccf2597c9259a8e71a2bffac5e11e12ea0)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * Copyright (C) 2018-2023 Oracle.  All Rights Reserved.
4  * Author: Darrick J. Wong <djwong@kernel.org>
5  */
6 #ifndef __XFS_SCRUB_REPAIR_H__
7 #define __XFS_SCRUB_REPAIR_H__
8 
9 #include "xfs_quota_defs.h"
10 
11 struct xchk_stats_run;
12 
13 static inline int xrep_notsupported(struct xfs_scrub *sc)
14 {
15 	return -EOPNOTSUPP;
16 }
17 
18 #ifdef CONFIG_XFS_ONLINE_REPAIR
19 
20 /*
21  * This is the maximum number of deferred extent freeing item extents (EFIs)
22  * that we'll attach to a transaction without rolling the transaction to avoid
23  * overrunning a tr_itruncate reservation.
24  */
25 #define XREP_MAX_ITRUNCATE_EFIS	(128)
26 
27 
28 /* Repair helpers */
29 
30 int xrep_attempt(struct xfs_scrub *sc, struct xchk_stats_run *run);
31 bool xrep_will_attempt(struct xfs_scrub *sc);
32 void xrep_failure(struct xfs_mount *mp);
33 int xrep_roll_ag_trans(struct xfs_scrub *sc);
34 int xrep_roll_trans(struct xfs_scrub *sc);
35 int xrep_defer_finish(struct xfs_scrub *sc);
36 bool xrep_ag_has_space(struct xfs_perag *pag, xfs_extlen_t nr_blocks,
37 		enum xfs_ag_resv_type type);
38 xfs_extlen_t xrep_calc_ag_resblks(struct xfs_scrub *sc);
39 
40 static inline int
41 xrep_trans_commit(
42 	struct xfs_scrub	*sc)
43 {
44 	int error = xfs_trans_commit(sc->tp);
45 
46 	sc->tp = NULL;
47 	return error;
48 }
49 
50 struct xbitmap;
51 struct xagb_bitmap;
52 struct xfsb_bitmap;
53 
54 int xrep_fix_freelist(struct xfs_scrub *sc, int alloc_flags);
55 
56 struct xrep_find_ag_btree {
57 	/* in: rmap owner of the btree we're looking for */
58 	uint64_t			rmap_owner;
59 
60 	/* in: buffer ops */
61 	const struct xfs_buf_ops	*buf_ops;
62 
63 	/* in: maximum btree height */
64 	unsigned int			maxlevels;
65 
66 	/* out: the highest btree block found and the tree height */
67 	xfs_agblock_t			root;
68 	unsigned int			height;
69 };
70 
71 int xrep_find_ag_btree_roots(struct xfs_scrub *sc, struct xfs_buf *agf_bp,
72 		struct xrep_find_ag_btree *btree_info, struct xfs_buf *agfl_bp);
73 
74 #ifdef CONFIG_XFS_QUOTA
75 void xrep_update_qflags(struct xfs_scrub *sc, unsigned int clear_flags,
76 		unsigned int set_flags);
77 void xrep_force_quotacheck(struct xfs_scrub *sc, xfs_dqtype_t type);
78 int xrep_ino_dqattach(struct xfs_scrub *sc);
79 #else
80 # define xrep_force_quotacheck(sc, type)	((void)0)
81 # define xrep_ino_dqattach(sc)			(0)
82 #endif /* CONFIG_XFS_QUOTA */
83 
84 int xrep_setup_xfbtree(struct xfs_scrub *sc, const char *descr);
85 
86 int xrep_ino_ensure_extent_count(struct xfs_scrub *sc, int whichfork,
87 		xfs_extnum_t nextents);
88 int xrep_reset_perag_resv(struct xfs_scrub *sc);
89 int xrep_bmap(struct xfs_scrub *sc, int whichfork, bool allow_unwritten);
90 int xrep_metadata_inode_forks(struct xfs_scrub *sc);
91 int xrep_setup_ag_rmapbt(struct xfs_scrub *sc);
92 int xrep_setup_ag_refcountbt(struct xfs_scrub *sc);
93 int xrep_setup_xattr(struct xfs_scrub *sc);
94 int xrep_setup_directory(struct xfs_scrub *sc);
95 int xrep_setup_parent(struct xfs_scrub *sc);
96 
97 /* Repair setup functions */
98 int xrep_setup_ag_allocbt(struct xfs_scrub *sc);
99 
100 struct xfs_imap;
101 int xrep_setup_inode(struct xfs_scrub *sc, const struct xfs_imap *imap);
102 
103 void xrep_ag_btcur_init(struct xfs_scrub *sc, struct xchk_ag *sa);
104 int xrep_ag_init(struct xfs_scrub *sc, struct xfs_perag *pag,
105 		struct xchk_ag *sa);
106 
107 /* Metadata revalidators */
108 
109 int xrep_revalidate_allocbt(struct xfs_scrub *sc);
110 int xrep_revalidate_iallocbt(struct xfs_scrub *sc);
111 
112 /* Metadata repairers */
113 
114 int xrep_probe(struct xfs_scrub *sc);
115 int xrep_superblock(struct xfs_scrub *sc);
116 int xrep_agf(struct xfs_scrub *sc);
117 int xrep_agfl(struct xfs_scrub *sc);
118 int xrep_agi(struct xfs_scrub *sc);
119 int xrep_allocbt(struct xfs_scrub *sc);
120 int xrep_iallocbt(struct xfs_scrub *sc);
121 int xrep_rmapbt(struct xfs_scrub *sc);
122 int xrep_refcountbt(struct xfs_scrub *sc);
123 int xrep_inode(struct xfs_scrub *sc);
124 int xrep_bmap_data(struct xfs_scrub *sc);
125 int xrep_bmap_attr(struct xfs_scrub *sc);
126 int xrep_bmap_cow(struct xfs_scrub *sc);
127 int xrep_nlinks(struct xfs_scrub *sc);
128 int xrep_fscounters(struct xfs_scrub *sc);
129 int xrep_xattr(struct xfs_scrub *sc);
130 int xrep_directory(struct xfs_scrub *sc);
131 int xrep_parent(struct xfs_scrub *sc);
132 
133 #ifdef CONFIG_XFS_RT
134 int xrep_rtbitmap(struct xfs_scrub *sc);
135 int xrep_rtsummary(struct xfs_scrub *sc);
136 #else
137 # define xrep_rtbitmap			xrep_notsupported
138 # define xrep_rtsummary			xrep_notsupported
139 #endif /* CONFIG_XFS_RT */
140 
141 #ifdef CONFIG_XFS_QUOTA
142 int xrep_quota(struct xfs_scrub *sc);
143 int xrep_quotacheck(struct xfs_scrub *sc);
144 #else
145 # define xrep_quota			xrep_notsupported
146 # define xrep_quotacheck		xrep_notsupported
147 #endif /* CONFIG_XFS_QUOTA */
148 
149 int xrep_reinit_pagf(struct xfs_scrub *sc);
150 int xrep_reinit_pagi(struct xfs_scrub *sc);
151 
152 int xrep_trans_alloc_hook_dummy(struct xfs_mount *mp, void **cookiep,
153 		struct xfs_trans **tpp);
154 void xrep_trans_cancel_hook_dummy(void **cookiep, struct xfs_trans *tp);
155 
156 bool xrep_buf_verify_struct(struct xfs_buf *bp, const struct xfs_buf_ops *ops);
157 
158 #else
159 
160 #define xrep_ino_dqattach(sc)	(0)
161 #define xrep_will_attempt(sc)	(false)
162 
163 static inline int
164 xrep_attempt(
165 	struct xfs_scrub	*sc,
166 	struct xchk_stats_run	*run)
167 {
168 	return -EOPNOTSUPP;
169 }
170 
171 static inline void xrep_failure(struct xfs_mount *mp) {}
172 
173 static inline xfs_extlen_t
174 xrep_calc_ag_resblks(
175 	struct xfs_scrub	*sc)
176 {
177 	return 0;
178 }
179 
180 static inline int
181 xrep_reset_perag_resv(
182 	struct xfs_scrub	*sc)
183 {
184 	if (!(sc->flags & XREP_RESET_PERAG_RESV))
185 		return 0;
186 
187 	ASSERT(0);
188 	return -EOPNOTSUPP;
189 }
190 
191 /* repair setup functions for no-repair */
192 static inline int
193 xrep_setup_nothing(
194 	struct xfs_scrub	*sc)
195 {
196 	return 0;
197 }
198 #define xrep_setup_ag_allocbt		xrep_setup_nothing
199 #define xrep_setup_ag_rmapbt		xrep_setup_nothing
200 #define xrep_setup_ag_refcountbt	xrep_setup_nothing
201 #define xrep_setup_xattr		xrep_setup_nothing
202 #define xrep_setup_directory		xrep_setup_nothing
203 #define xrep_setup_parent		xrep_setup_nothing
204 
205 #define xrep_setup_inode(sc, imap)	((void)0)
206 
207 #define xrep_revalidate_allocbt		(NULL)
208 #define xrep_revalidate_iallocbt	(NULL)
209 
210 #define xrep_probe			xrep_notsupported
211 #define xrep_superblock			xrep_notsupported
212 #define xrep_agf			xrep_notsupported
213 #define xrep_agfl			xrep_notsupported
214 #define xrep_agi			xrep_notsupported
215 #define xrep_allocbt			xrep_notsupported
216 #define xrep_iallocbt			xrep_notsupported
217 #define xrep_rmapbt			xrep_notsupported
218 #define xrep_refcountbt			xrep_notsupported
219 #define xrep_inode			xrep_notsupported
220 #define xrep_bmap_data			xrep_notsupported
221 #define xrep_bmap_attr			xrep_notsupported
222 #define xrep_bmap_cow			xrep_notsupported
223 #define xrep_rtbitmap			xrep_notsupported
224 #define xrep_quota			xrep_notsupported
225 #define xrep_quotacheck			xrep_notsupported
226 #define xrep_nlinks			xrep_notsupported
227 #define xrep_fscounters			xrep_notsupported
228 #define xrep_rtsummary			xrep_notsupported
229 #define xrep_xattr			xrep_notsupported
230 #define xrep_directory			xrep_notsupported
231 #define xrep_parent			xrep_notsupported
232 
233 #endif /* CONFIG_XFS_ONLINE_REPAIR */
234 
235 #endif	/* __XFS_SCRUB_REPAIR_H__ */
236