repair.h

  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
 11struct xfs_rtgroup;
 12struct xchk_stats_run;
 13
 14static inline int xrep_notsupported(struct xfs_scrub *sc)
 15{
 16	return -EOPNOTSUPP;
 17}
 18
 19#ifdef CONFIG_XFS_ONLINE_REPAIR
 20
 21/* Repair helpers */
 22
 23int xrep_attempt(struct xfs_scrub *sc, struct xchk_stats_run *run);
 24bool xrep_will_attempt(struct xfs_scrub *sc);
 25void xrep_failure(struct xfs_mount *mp);
 26int xrep_roll_ag_trans(struct xfs_scrub *sc);
 27int xrep_roll_trans(struct xfs_scrub *sc);
 28int xrep_defer_finish(struct xfs_scrub *sc);
 29bool xrep_ag_has_space(struct xfs_perag *pag, xfs_extlen_t nr_blocks,
 30		enum xfs_ag_resv_type type);
 31xfs_extlen_t xrep_calc_ag_resblks(struct xfs_scrub *sc);
 32
 33static inline int
 34xrep_trans_commit(
 35	struct xfs_scrub	*sc)
 36{
 37	int error = xfs_trans_commit(sc->tp);
 38
 39	sc->tp = NULL;
 40	return error;
 41}
 42
 43struct xbitmap;
 44struct xagb_bitmap;
 45struct xrgb_bitmap;
 46struct xfsb_bitmap;
 47struct xrtb_bitmap;
 48
 49int xrep_fix_freelist(struct xfs_scrub *sc, int alloc_flags);
 50
 51struct xrep_find_ag_btree {
 52	/* in: rmap owner of the btree we're looking for */
 53	uint64_t			rmap_owner;
 54
 55	/* in: buffer ops */
 56	const struct xfs_buf_ops	*buf_ops;
 57
 58	/* in: maximum btree height */
 59	unsigned int			maxlevels;
 60
 61	/* out: the highest btree block found and the tree height */
 62	xfs_agblock_t			root;
 63	unsigned int			height;
 64};
 65
 66int xrep_find_ag_btree_roots(struct xfs_scrub *sc, struct xfs_buf *agf_bp,
 67		struct xrep_find_ag_btree *btree_info, struct xfs_buf *agfl_bp);
 68
 69#ifdef CONFIG_XFS_QUOTA
 70void xrep_update_qflags(struct xfs_scrub *sc, unsigned int clear_flags,
 71		unsigned int set_flags);
 72void xrep_force_quotacheck(struct xfs_scrub *sc, xfs_dqtype_t type);
 73int xrep_ino_dqattach(struct xfs_scrub *sc);
 74#else
 75# define xrep_force_quotacheck(sc, type)	((void)0)
 76# define xrep_ino_dqattach(sc)			(0)
 77#endif /* CONFIG_XFS_QUOTA */
 78
 79int xrep_setup_xfbtree(struct xfs_scrub *sc, const char *descr);
 80
 81int xrep_ino_ensure_extent_count(struct xfs_scrub *sc, int whichfork,
 82		xfs_extnum_t nextents);
 83int xrep_reset_perag_resv(struct xfs_scrub *sc);
 84int xrep_bmap(struct xfs_scrub *sc, int whichfork, bool allow_unwritten);
 85int xrep_metadata_inode_forks(struct xfs_scrub *sc);
 86int xrep_setup_ag_rmapbt(struct xfs_scrub *sc);
 87int xrep_setup_ag_refcountbt(struct xfs_scrub *sc);
 88int xrep_setup_xattr(struct xfs_scrub *sc);
 89int xrep_setup_directory(struct xfs_scrub *sc);
 90int xrep_setup_parent(struct xfs_scrub *sc);
 91int xrep_setup_nlinks(struct xfs_scrub *sc);
 92int xrep_setup_symlink(struct xfs_scrub *sc, unsigned int *resblks);
 93int xrep_setup_dirtree(struct xfs_scrub *sc);
 94int xrep_setup_rtrmapbt(struct xfs_scrub *sc);
 95int xrep_setup_rtrefcountbt(struct xfs_scrub *sc);
 96
 97/* Repair setup functions */
 98int xrep_setup_ag_allocbt(struct xfs_scrub *sc);
 99
100struct xfs_imap;
101int xrep_setup_inode(struct xfs_scrub *sc, const struct xfs_imap *imap);
102
103void xrep_ag_btcur_init(struct xfs_scrub *sc, struct xchk_ag *sa);
104int xrep_ag_init(struct xfs_scrub *sc, struct xfs_perag *pag,
105		struct xchk_ag *sa);
106#ifdef CONFIG_XFS_RT
107int xrep_rtgroup_init(struct xfs_scrub *sc, struct xfs_rtgroup *rtg,
108		struct xchk_rt *sr, unsigned int rtglock_flags);
109void xrep_rtgroup_btcur_init(struct xfs_scrub *sc, struct xchk_rt *sr);
110int xrep_require_rtext_inuse(struct xfs_scrub *sc, xfs_rgblock_t rgbno,
111		xfs_filblks_t len);
112xfs_extlen_t xrep_calc_rtgroup_resblks(struct xfs_scrub *sc);
113#else
114# define xrep_rtgroup_init(sc, rtg, sr, lockflags)	(-ENOSYS)
115# define xrep_calc_rtgroup_resblks(sc)			(0)
116#endif /* CONFIG_XFS_RT */
117
118int xrep_check_ino_btree_mapping(struct xfs_scrub *sc,
119		const struct xfs_rmap_irec *rec);
120
121/* Metadata revalidators */
122
123int xrep_revalidate_allocbt(struct xfs_scrub *sc);
124int xrep_revalidate_iallocbt(struct xfs_scrub *sc);
125
126/* Metadata repairers */
127
128int xrep_probe(struct xfs_scrub *sc);
129int xrep_superblock(struct xfs_scrub *sc);
130int xrep_agf(struct xfs_scrub *sc);
131int xrep_agfl(struct xfs_scrub *sc);
132int xrep_agi(struct xfs_scrub *sc);
133int xrep_allocbt(struct xfs_scrub *sc);
134int xrep_iallocbt(struct xfs_scrub *sc);
135int xrep_rmapbt(struct xfs_scrub *sc);
136int xrep_refcountbt(struct xfs_scrub *sc);
137int xrep_inode(struct xfs_scrub *sc);
138int xrep_bmap_data(struct xfs_scrub *sc);
139int xrep_bmap_attr(struct xfs_scrub *sc);
140int xrep_bmap_cow(struct xfs_scrub *sc);
141int xrep_nlinks(struct xfs_scrub *sc);
142int xrep_fscounters(struct xfs_scrub *sc);
143int xrep_xattr(struct xfs_scrub *sc);
144int xrep_directory(struct xfs_scrub *sc);
145int xrep_parent(struct xfs_scrub *sc);
146int xrep_symlink(struct xfs_scrub *sc);
147int xrep_dirtree(struct xfs_scrub *sc);
148int xrep_metapath(struct xfs_scrub *sc);
149
150#ifdef CONFIG_XFS_RT
151int xrep_rtbitmap(struct xfs_scrub *sc);
152int xrep_rtsummary(struct xfs_scrub *sc);
153int xrep_rgsuperblock(struct xfs_scrub *sc);
154int xrep_rtrmapbt(struct xfs_scrub *sc);
155int xrep_rtrefcountbt(struct xfs_scrub *sc);
156#else
157# define xrep_rtbitmap			xrep_notsupported
158# define xrep_rtsummary			xrep_notsupported
159# define xrep_rgsuperblock		xrep_notsupported
160# define xrep_rtrmapbt			xrep_notsupported
161# define xrep_rtrefcountbt		xrep_notsupported
162#endif /* CONFIG_XFS_RT */
163
164#ifdef CONFIG_XFS_QUOTA
165int xrep_quota(struct xfs_scrub *sc);
166int xrep_quotacheck(struct xfs_scrub *sc);
167#else
168# define xrep_quota			xrep_notsupported
169# define xrep_quotacheck		xrep_notsupported
170#endif /* CONFIG_XFS_QUOTA */
171
172int xrep_reinit_pagf(struct xfs_scrub *sc);
173int xrep_reinit_pagi(struct xfs_scrub *sc);
174
175bool xrep_buf_verify_struct(struct xfs_buf *bp, const struct xfs_buf_ops *ops);
176void xrep_inode_set_nblocks(struct xfs_scrub *sc, int64_t new_blocks);
177int xrep_reset_metafile_resv(struct xfs_scrub *sc);
178
179#else
180
181#define xrep_ino_dqattach(sc)	(0)
182
183/*
184 * When online repair is not built into the kernel, we still want to attempt
185 * the repair so that the stub xrep_attempt below will return EOPNOTSUPP.
186 */
187static inline bool xrep_will_attempt(const struct xfs_scrub *sc)
188{
189	return (sc->sm->sm_flags & XFS_SCRUB_IFLAG_FORCE_REBUILD) ||
190		xchk_needs_repair(sc->sm);
191}
192
193static inline int
194xrep_attempt(
195	struct xfs_scrub	*sc,
196	struct xchk_stats_run	*run)
197{
198	return -EOPNOTSUPP;
199}
200
201static inline void xrep_failure(struct xfs_mount *mp) {}
202
203static inline xfs_extlen_t
204xrep_calc_ag_resblks(
205	struct xfs_scrub	*sc)
206{
207	return 0;
208}
209
210#define xrep_calc_rtgroup_resblks	xrep_calc_ag_resblks
211
212static inline int
213xrep_reset_perag_resv(
214	struct xfs_scrub	*sc)
215{
216	if (!(sc->flags & XREP_RESET_PERAG_RESV))
217		return 0;
218
219	ASSERT(0);
220	return -EOPNOTSUPP;
221}
222
223/* repair setup functions for no-repair */
224static inline int
225xrep_setup_nothing(
226	struct xfs_scrub	*sc)
227{
228	return 0;
229}
230#define xrep_setup_ag_allocbt		xrep_setup_nothing
231#define xrep_setup_ag_rmapbt		xrep_setup_nothing
232#define xrep_setup_ag_refcountbt	xrep_setup_nothing
233#define xrep_setup_xattr		xrep_setup_nothing
234#define xrep_setup_directory		xrep_setup_nothing
235#define xrep_setup_parent		xrep_setup_nothing
236#define xrep_setup_nlinks		xrep_setup_nothing
237#define xrep_setup_dirtree		xrep_setup_nothing
238#define xrep_setup_metapath		xrep_setup_nothing
239#define xrep_setup_rtrmapbt		xrep_setup_nothing
240#define xrep_setup_rtrefcountbt		xrep_setup_nothing
241
242#define xrep_setup_inode(sc, imap)	((void)0)
243
244static inline int xrep_setup_symlink(struct xfs_scrub *sc, unsigned int *x)
245{
246	return 0;
247}
248
249#define xrep_revalidate_allocbt		(NULL)
250#define xrep_revalidate_iallocbt	(NULL)
251
252#define xrep_probe			xrep_notsupported
253#define xrep_superblock			xrep_notsupported
254#define xrep_agf			xrep_notsupported
255#define xrep_agfl			xrep_notsupported
256#define xrep_agi			xrep_notsupported
257#define xrep_allocbt			xrep_notsupported
258#define xrep_iallocbt			xrep_notsupported
259#define xrep_rmapbt			xrep_notsupported
260#define xrep_refcountbt			xrep_notsupported
261#define xrep_inode			xrep_notsupported
262#define xrep_bmap_data			xrep_notsupported
263#define xrep_bmap_attr			xrep_notsupported
264#define xrep_bmap_cow			xrep_notsupported
265#define xrep_rtbitmap			xrep_notsupported
266#define xrep_quota			xrep_notsupported
267#define xrep_quotacheck			xrep_notsupported
268#define xrep_nlinks			xrep_notsupported
269#define xrep_fscounters			xrep_notsupported
270#define xrep_rtsummary			xrep_notsupported
271#define xrep_xattr			xrep_notsupported
272#define xrep_directory			xrep_notsupported
273#define xrep_parent			xrep_notsupported
274#define xrep_symlink			xrep_notsupported
275#define xrep_dirtree			xrep_notsupported
276#define xrep_metapath			xrep_notsupported
277#define xrep_rgsuperblock		xrep_notsupported
278#define xrep_rtrmapbt			xrep_notsupported
279#define xrep_rtrefcountbt		xrep_notsupported
280
281#endif /* CONFIG_XFS_ONLINE_REPAIR */
282
283#endif	/* __XFS_SCRUB_REPAIR_H__ */