[mirror_ubuntu-jammy-kernel.git] / fs / xfs / scrub / common.h

/*
 * Copyright (C) 2017 Oracle.  All Rights Reserved.
 *
 * Author: Darrick J. Wong <darrick.wong@oracle.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it would be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write the Free Software Foundation,
 * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA.
 */
#ifndef __XFS_SCRUB_COMMON_H__
#define __XFS_SCRUB_COMMON_H__

/*
 * We /could/ terminate a scrub/repair operation early.  If we're not
 * in a good place to continue (fatal signal, etc.) then bail out.
 * Note that we're careful not to make any judgements about *error.
 */
static inline bool
xfs_scrub_should_terminate(
	struct xfs_scrub_context	*sc,
	int				*error)
{
	if (fatal_signal_pending(current)) {
		if (*error == 0)
			*error = -EAGAIN;
		return true;
	}
	return false;
}

/*
 * Grab an empty transaction so that we can re-grab locked buffers if
 * one of our btrees turns out to be cyclic.
 */
static inline int
xfs_scrub_trans_alloc(
	struct xfs_scrub_metadata	*sm,
	struct xfs_mount		*mp,
	struct xfs_trans		**tpp)
{
	return xfs_trans_alloc_empty(mp, tpp);
}

bool xfs_scrub_process_error(struct xfs_scrub_context *sc, xfs_agnumber_t agno,
		xfs_agblock_t bno, int *error);
bool xfs_scrub_fblock_process_error(struct xfs_scrub_context *sc, int whichfork,
		xfs_fileoff_t offset, int *error);

bool xfs_scrub_xref_process_error(struct xfs_scrub_context *sc,
		xfs_agnumber_t agno, xfs_agblock_t bno, int *error);
bool xfs_scrub_fblock_xref_process_error(struct xfs_scrub_context *sc,
		int whichfork, xfs_fileoff_t offset, int *error);

void xfs_scrub_block_set_preen(struct xfs_scrub_context *sc,
		struct xfs_buf *bp);
void xfs_scrub_ino_set_preen(struct xfs_scrub_context *sc, xfs_ino_t ino);

void xfs_scrub_block_set_corrupt(struct xfs_scrub_context *sc,
		struct xfs_buf *bp);
void xfs_scrub_ino_set_corrupt(struct xfs_scrub_context *sc, xfs_ino_t ino);
void xfs_scrub_fblock_set_corrupt(struct xfs_scrub_context *sc, int whichfork,
		xfs_fileoff_t offset);

void xfs_scrub_block_xref_set_corrupt(struct xfs_scrub_context *sc,
		struct xfs_buf *bp);
void xfs_scrub_ino_xref_set_corrupt(struct xfs_scrub_context *sc,
		xfs_ino_t ino);
void xfs_scrub_fblock_xref_set_corrupt(struct xfs_scrub_context *sc,
		int whichfork, xfs_fileoff_t offset);

void xfs_scrub_ino_set_warning(struct xfs_scrub_context *sc, xfs_ino_t ino);
void xfs_scrub_fblock_set_warning(struct xfs_scrub_context *sc, int whichfork,
		xfs_fileoff_t offset);

void xfs_scrub_set_incomplete(struct xfs_scrub_context *sc);
int xfs_scrub_checkpoint_log(struct xfs_mount *mp);

/* Are we set up for a cross-referencing check? */
bool xfs_scrub_should_check_xref(struct xfs_scrub_context *sc, int *error,
			   struct xfs_btree_cur **curpp);

/* Setup functions */
int xfs_scrub_setup_fs(struct xfs_scrub_context *sc, struct xfs_inode *ip);
int xfs_scrub_setup_ag_allocbt(struct xfs_scrub_context *sc,
			       struct xfs_inode *ip);
int xfs_scrub_setup_ag_iallocbt(struct xfs_scrub_context *sc,
				struct xfs_inode *ip);
int xfs_scrub_setup_ag_rmapbt(struct xfs_scrub_context *sc,
			      struct xfs_inode *ip);
int xfs_scrub_setup_ag_refcountbt(struct xfs_scrub_context *sc,
				  struct xfs_inode *ip);
int xfs_scrub_setup_inode(struct xfs_scrub_context *sc,
			  struct xfs_inode *ip);
int xfs_scrub_setup_inode_bmap(struct xfs_scrub_context *sc,
			       struct xfs_inode *ip);
int xfs_scrub_setup_inode_bmap_data(struct xfs_scrub_context *sc,
				    struct xfs_inode *ip);
int xfs_scrub_setup_directory(struct xfs_scrub_context *sc,
			      struct xfs_inode *ip);
int xfs_scrub_setup_xattr(struct xfs_scrub_context *sc,
			  struct xfs_inode *ip);
int xfs_scrub_setup_symlink(struct xfs_scrub_context *sc,
			    struct xfs_inode *ip);
int xfs_scrub_setup_parent(struct xfs_scrub_context *sc,
			   struct xfs_inode *ip);
#ifdef CONFIG_XFS_RT
int xfs_scrub_setup_rt(struct xfs_scrub_context *sc, struct xfs_inode *ip);
#else
static inline int
xfs_scrub_setup_rt(struct xfs_scrub_context *sc, struct xfs_inode *ip)
{
	return -ENOENT;
}
#endif
#ifdef CONFIG_XFS_QUOTA
int xfs_scrub_setup_quota(struct xfs_scrub_context *sc, struct xfs_inode *ip);
#else
static inline int
xfs_scrub_setup_quota(struct xfs_scrub_context *sc, struct xfs_inode *ip)
{
	return -ENOENT;
}
#endif

void xfs_scrub_ag_free(struct xfs_scrub_context *sc, struct xfs_scrub_ag *sa);
int xfs_scrub_ag_init(struct xfs_scrub_context *sc, xfs_agnumber_t agno,
		      struct xfs_scrub_ag *sa);
int xfs_scrub_ag_read_headers(struct xfs_scrub_context *sc, xfs_agnumber_t agno,
			      struct xfs_buf **agi, struct xfs_buf **agf,
			      struct xfs_buf **agfl);
void xfs_scrub_ag_btcur_free(struct xfs_scrub_ag *sa);
int xfs_scrub_ag_btcur_init(struct xfs_scrub_context *sc,
			    struct xfs_scrub_ag *sa);
int xfs_scrub_walk_agfl(struct xfs_scrub_context *sc,
			int (*fn)(struct xfs_scrub_context *, xfs_agblock_t bno,
				  void *),
			void *priv);
int xfs_scrub_count_rmap_ownedby_ag(struct xfs_scrub_context *sc,
				    struct xfs_btree_cur *cur,
				    struct xfs_owner_info *oinfo,
				    xfs_filblks_t *blocks);

int xfs_scrub_setup_ag_btree(struct xfs_scrub_context *sc,
			     struct xfs_inode *ip, bool force_log);
int xfs_scrub_get_inode(struct xfs_scrub_context *sc, struct xfs_inode *ip_in);
int xfs_scrub_setup_inode_contents(struct xfs_scrub_context *sc,
				   struct xfs_inode *ip, unsigned int resblks);
void xfs_scrub_buffer_recheck(struct xfs_scrub_context *sc, struct xfs_buf *bp);

#endif	/* __XFS_SCRUB_COMMON_H__ */
Commit	Line	Data
dcb660f9 DW	1	/*
	2	* Copyright (C) 2017 Oracle. All Rights Reserved.
	3	*
	4	* Author: Darrick J. Wong <darrick.wong@oracle.com>
	5	*
	6	* This program is free software; you can redistribute it and/or
	7	* modify it under the terms of the GNU General Public License
	8	* as published by the Free Software Foundation; either version 2
	9	* of the License, or (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it would be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write the Free Software Foundation,
	18	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
	19	*/
	20	#ifndef __XFS_SCRUB_COMMON_H__
	21	#define __XFS_SCRUB_COMMON_H__
	22
	23	/*
	24	* We /could/ terminate a scrub/repair operation early. If we're not
	25	* in a good place to continue (fatal signal, etc.) then bail out.
	26	* Note that we're careful not to make any judgements about *error.
	27	*/
	28	static inline bool
	29	xfs_scrub_should_terminate(
	30	struct xfs_scrub_context *sc,
	31	int *error)
	32	{
	33	if (fatal_signal_pending(current)) {
	34	if (*error == 0)
	35	*error = -EAGAIN;
	36	return true;
	37	}
	38	return false;
	39	}
	40
	41	/*
	42	* Grab an empty transaction so that we can re-grab locked buffers if
	43	* one of our btrees turns out to be cyclic.
	44	*/
	45	static inline int
	46	xfs_scrub_trans_alloc(
	47	struct xfs_scrub_metadata *sm,
	48	struct xfs_mount *mp,
	49	struct xfs_trans **tpp)
	50	{
	51	return xfs_trans_alloc_empty(mp, tpp);
	52	}
	53
4700d229 DW	54	bool xfs_scrub_process_error(struct xfs_scrub_context *sc, xfs_agnumber_t agno,
	55	xfs_agblock_t bno, int *error);
	56	bool xfs_scrub_fblock_process_error(struct xfs_scrub_context *sc, int whichfork,
	57	xfs_fileoff_t offset, int *error);
	58
64b12563 DW	59	bool xfs_scrub_xref_process_error(struct xfs_scrub_context *sc,
	60	xfs_agnumber_t agno, xfs_agblock_t bno, int *error);
	61	bool xfs_scrub_fblock_xref_process_error(struct xfs_scrub_context *sc,
	62	int whichfork, xfs_fileoff_t offset, int *error);
	63
4700d229 DW	64	void xfs_scrub_block_set_preen(struct xfs_scrub_context *sc,
4700d229 DW	65	struct xfs_buf *bp);
7e56d9ea	66	void xfs_scrub_ino_set_preen(struct xfs_scrub_context *sc, xfs_ino_t ino);
4700d229 DW	67
	68	void xfs_scrub_block_set_corrupt(struct xfs_scrub_context *sc,
	69	struct xfs_buf *bp);
7e56d9ea	70	void xfs_scrub_ino_set_corrupt(struct xfs_scrub_context *sc, xfs_ino_t ino);
4700d229 DW	71	void xfs_scrub_fblock_set_corrupt(struct xfs_scrub_context *sc, int whichfork,
	72	xfs_fileoff_t offset);
	73
64b12563 DW	74	void xfs_scrub_block_xref_set_corrupt(struct xfs_scrub_context *sc,
64b12563 DW	75	struct xfs_buf *bp);
7e56d9ea DW	76	void xfs_scrub_ino_xref_set_corrupt(struct xfs_scrub_context *sc,
7e56d9ea DW	77	xfs_ino_t ino);
64b12563 DW	78	void xfs_scrub_fblock_xref_set_corrupt(struct xfs_scrub_context *sc,
	79	int whichfork, xfs_fileoff_t offset);
	80
7e56d9ea	81	void xfs_scrub_ino_set_warning(struct xfs_scrub_context *sc, xfs_ino_t ino);
4700d229 DW	82	void xfs_scrub_fblock_set_warning(struct xfs_scrub_context *sc, int whichfork,
	83	xfs_fileoff_t offset);
	84
	85	void xfs_scrub_set_incomplete(struct xfs_scrub_context *sc);
3daa6641	86	int xfs_scrub_checkpoint_log(struct xfs_mount *mp);
4700d229	87
64b12563 DW	88	/* Are we set up for a cross-referencing check? */
	89	bool xfs_scrub_should_check_xref(struct xfs_scrub_context sc, int error,
	90	struct xfs_btree_cur **curpp);
	91
dcb660f9 DW	92	/* Setup functions */
dcb660f9 DW	93	int xfs_scrub_setup_fs(struct xfs_scrub_context sc, struct xfs_inode ip);
efa7a99c DW	94	int xfs_scrub_setup_ag_allocbt(struct xfs_scrub_context *sc,
efa7a99c DW	95	struct xfs_inode *ip);
3daa6641 DW	96	int xfs_scrub_setup_ag_iallocbt(struct xfs_scrub_context *sc,
3daa6641 DW	97	struct xfs_inode *ip);
c7e693d9 DW	98	int xfs_scrub_setup_ag_rmapbt(struct xfs_scrub_context *sc,
c7e693d9 DW	99	struct xfs_inode *ip);
edc09b52 DW	100	int xfs_scrub_setup_ag_refcountbt(struct xfs_scrub_context *sc,
edc09b52 DW	101	struct xfs_inode *ip);
80e4e126 DW	102	int xfs_scrub_setup_inode(struct xfs_scrub_context *sc,
80e4e126 DW	103	struct xfs_inode *ip);
99d9d8d0 DW	104	int xfs_scrub_setup_inode_bmap(struct xfs_scrub_context *sc,
	105	struct xfs_inode *ip);
	106	int xfs_scrub_setup_inode_bmap_data(struct xfs_scrub_context *sc,
	107	struct xfs_inode *ip);
a5c46e5e DW	108	int xfs_scrub_setup_directory(struct xfs_scrub_context *sc,
a5c46e5e DW	109	struct xfs_inode *ip);
eec0482e DW	110	int xfs_scrub_setup_xattr(struct xfs_scrub_context *sc,
eec0482e DW	111	struct xfs_inode *ip);
2a721dbb DW	112	int xfs_scrub_setup_symlink(struct xfs_scrub_context *sc,
2a721dbb DW	113	struct xfs_inode *ip);
0f28b257 DW	114	int xfs_scrub_setup_parent(struct xfs_scrub_context *sc,
0f28b257 DW	115	struct xfs_inode *ip);
29b0767b DW	116	#ifdef CONFIG_XFS_RT
	117	int xfs_scrub_setup_rt(struct xfs_scrub_context sc, struct xfs_inode ip);
	118	#else
	119	static inline int
	120	xfs_scrub_setup_rt(struct xfs_scrub_context sc, struct xfs_inode ip)
c2fc338c DW	121	{
	122	return -ENOENT;
	123	}
	124	#endif
	125	#ifdef CONFIG_XFS_QUOTA
	126	int xfs_scrub_setup_quota(struct xfs_scrub_context sc, struct xfs_inode ip);
	127	#else
	128	static inline int
	129	xfs_scrub_setup_quota(struct xfs_scrub_context sc, struct xfs_inode ip)
29b0767b DW	130	{
	131	return -ENOENT;
	132	}
	133	#endif
dcb660f9	134
b6c1beb9 DW	135	void xfs_scrub_ag_free(struct xfs_scrub_context sc, struct xfs_scrub_ag sa);
	136	int xfs_scrub_ag_init(struct xfs_scrub_context *sc, xfs_agnumber_t agno,
	137	struct xfs_scrub_ag *sa);
	138	int xfs_scrub_ag_read_headers(struct xfs_scrub_context *sc, xfs_agnumber_t agno,
	139	struct xfs_buf agi, struct xfs_buf agf,
	140	struct xfs_buf **agfl);
	141	void xfs_scrub_ag_btcur_free(struct xfs_scrub_ag *sa);
	142	int xfs_scrub_ag_btcur_init(struct xfs_scrub_context *sc,
	143	struct xfs_scrub_ag *sa);
ab9d5dc5 DW	144	int xfs_scrub_walk_agfl(struct xfs_scrub_context *sc,
	145	int (fn)(struct xfs_scrub_context , xfs_agblock_t bno,
	146	void *),
	147	void *priv);
d852657c DW	148	int xfs_scrub_count_rmap_ownedby_ag(struct xfs_scrub_context *sc,
	149	struct xfs_btree_cur *cur,
	150	struct xfs_owner_info *oinfo,
	151	xfs_filblks_t *blocks);
b6c1beb9	152
efa7a99c DW	153	int xfs_scrub_setup_ag_btree(struct xfs_scrub_context *sc,
efa7a99c DW	154	struct xfs_inode *ip, bool force_log);
80e4e126	155	int xfs_scrub_get_inode(struct xfs_scrub_context sc, struct xfs_inode ip_in);
a5c46e5e DW	156	int xfs_scrub_setup_inode_contents(struct xfs_scrub_context *sc,
a5c46e5e DW	157	struct xfs_inode *ip, unsigned int resblks);
cf1b0b8b	158	void xfs_scrub_buffer_recheck(struct xfs_scrub_context sc, struct xfs_buf bp);
efa7a99c	159
dcb660f9	160	#endif /* __XFS_SCRUB_COMMON_H__ */