[linux-2.6-block.git] / fs / xfs / scrub / scrub.h

// SPDX-License-Identifier: GPL-2.0+
/*
 * Copyright (C) 2017 Oracle.  All Rights Reserved.
 * Author: Darrick J. Wong <darrick.wong@oracle.com>
 */
#ifndef __XFS_SCRUB_SCRUB_H__
#define __XFS_SCRUB_SCRUB_H__

struct xfs_scrub;

/* Type info and names for the scrub types. */
enum xchk_type {
	ST_NONE = 1,	/* disabled */
	ST_PERAG,	/* per-AG metadata */
	ST_FS,		/* per-FS metadata */
	ST_INODE,	/* per-inode metadata */
};

struct xchk_meta_ops {
	/* Acquire whatever resources are needed for the operation. */
	int		(*setup)(struct xfs_scrub *,
				 struct xfs_inode *);

	/* Examine metadata for errors. */
	int		(*scrub)(struct xfs_scrub *);

	/* Repair or optimize the metadata. */
	int		(*repair)(struct xfs_scrub *);

	/* Decide if we even have this piece of metadata. */
	bool		(*has)(struct xfs_sb *);

	/* type describing required/allowed inputs */
	enum xchk_type	type;
};

/* Buffer pointers and btree cursors for an entire AG. */
struct xchk_ag {
	xfs_agnumber_t		agno;
	struct xfs_perag	*pag;

	/* AG btree roots */
	struct xfs_buf		*agf_bp;
	struct xfs_buf		*agfl_bp;
	struct xfs_buf		*agi_bp;

	/* AG btrees */
	struct xfs_btree_cur	*bno_cur;
	struct xfs_btree_cur	*cnt_cur;
	struct xfs_btree_cur	*ino_cur;
	struct xfs_btree_cur	*fino_cur;
	struct xfs_btree_cur	*rmap_cur;
	struct xfs_btree_cur	*refc_cur;
};

struct xfs_scrub {
	/* General scrub state. */
	struct xfs_mount		*mp;
	struct xfs_scrub_metadata	*sm;
	const struct xchk_meta_ops	*ops;
	struct xfs_trans		*tp;
	struct xfs_inode		*ip;
	void				*buf;
	uint				ilock_flags;
	bool				try_harder;
	bool				has_quotaofflock;

	/* State tracking for single-AG operations. */
	struct xchk_ag			sa;
};

/* Metadata scrubbers */
int xchk_tester(struct xfs_scrub *sc);
int xchk_superblock(struct xfs_scrub *sc);
int xchk_agf(struct xfs_scrub *sc);
int xchk_agfl(struct xfs_scrub *sc);
int xchk_agi(struct xfs_scrub *sc);
int xchk_bnobt(struct xfs_scrub *sc);
int xchk_cntbt(struct xfs_scrub *sc);
int xchk_inobt(struct xfs_scrub *sc);
int xchk_finobt(struct xfs_scrub *sc);
int xchk_rmapbt(struct xfs_scrub *sc);
int xchk_refcountbt(struct xfs_scrub *sc);
int xchk_inode(struct xfs_scrub *sc);
int xchk_bmap_data(struct xfs_scrub *sc);
int xchk_bmap_attr(struct xfs_scrub *sc);
int xchk_bmap_cow(struct xfs_scrub *sc);
int xchk_directory(struct xfs_scrub *sc);
int xchk_xattr(struct xfs_scrub *sc);
int xchk_symlink(struct xfs_scrub *sc);
int xchk_parent(struct xfs_scrub *sc);
#ifdef CONFIG_XFS_RT
int xchk_rtbitmap(struct xfs_scrub *sc);
int xchk_rtsummary(struct xfs_scrub *sc);
#else
static inline int
xchk_rtbitmap(struct xfs_scrub *sc)
{
	return -ENOENT;
}
static inline int
xchk_rtsummary(struct xfs_scrub *sc)
{
	return -ENOENT;
}
#endif
#ifdef CONFIG_XFS_QUOTA
int xchk_quota(struct xfs_scrub *sc);
#else
static inline int
xchk_quota(struct xfs_scrub *sc)
{
	return -ENOENT;
}
#endif

/* cross-referencing helpers */
void xchk_xref_is_used_space(struct xfs_scrub *sc, xfs_agblock_t agbno,
		xfs_extlen_t len);
void xchk_xref_is_not_inode_chunk(struct xfs_scrub *sc, xfs_agblock_t agbno,
		xfs_extlen_t len);
void xchk_xref_is_inode_chunk(struct xfs_scrub *sc, xfs_agblock_t agbno,
		xfs_extlen_t len);
void xchk_xref_is_owned_by(struct xfs_scrub *sc, xfs_agblock_t agbno,
		xfs_extlen_t len, const struct xfs_owner_info *oinfo);
void xchk_xref_is_not_owned_by(struct xfs_scrub *sc, xfs_agblock_t agbno,
		xfs_extlen_t len, const struct xfs_owner_info *oinfo);
void xchk_xref_has_no_owner(struct xfs_scrub *sc, xfs_agblock_t agbno,
		xfs_extlen_t len);
void xchk_xref_is_cow_staging(struct xfs_scrub *sc, xfs_agblock_t bno,
		xfs_extlen_t len);
void xchk_xref_is_not_shared(struct xfs_scrub *sc, xfs_agblock_t bno,
		xfs_extlen_t len);
#ifdef CONFIG_XFS_RT
void xchk_xref_is_used_rt_space(struct xfs_scrub *sc, xfs_rtblock_t rtbno,
		xfs_extlen_t len);
#else
# define xchk_xref_is_used_rt_space(sc, rtbno, len) do { } while (0)
#endif

#endif	/* __XFS_SCRUB_SCRUB_H__ */
Commit	Line	Data
0b61f8a4	1	// SPDX-License-Identifier: GPL-2.0+
36fd6e86 DW	2	/*
36fd6e86 DW	3	* Copyright (C) 2017 Oracle. All Rights Reserved.
36fd6e86	4	* Author: Darrick J. Wong <darrick.wong@oracle.com>
36fd6e86 DW	5	*/
	6	#ifndef __XFS_SCRUB_SCRUB_H__
	7	#define __XFS_SCRUB_SCRUB_H__
	8
1d8a748a	9	struct xfs_scrub;
a5637186	10
8e630837	11	/* Type info and names for the scrub types. */
c517b3aa	12	enum xchk_type {
8e630837 ES	13	ST_NONE = 1, /* disabled */
	14	ST_PERAG, /* per-AG metadata */
	15	ST_FS, /* per-FS metadata */
	16	ST_INODE, /* per-inode metadata */
	17	};
	18
c517b3aa	19	struct xchk_meta_ops {
a5637186	20	/* Acquire whatever resources are needed for the operation. */
1d8a748a	21	int (setup)(struct xfs_scrub ,
a5637186 DW	22	struct xfs_inode *);
	23
	24	/* Examine metadata for errors. */
1d8a748a	25	int (scrub)(struct xfs_scrub );
a5637186	26
84d42ea6	27	/* Repair or optimize the metadata. */
1d8a748a	28	int (repair)(struct xfs_scrub );
84d42ea6	29
a5637186 DW	30	/* Decide if we even have this piece of metadata. */
a5637186 DW	31	bool (has)(struct xfs_sb );
8e630837 ES	32
8e630837 ES	33	/* type describing required/allowed inputs */
c517b3aa	34	enum xchk_type type;
a5637186 DW	35	};
a5637186 DW	36
b6c1beb9	37	/* Buffer pointers and btree cursors for an entire AG. */
c517b3aa	38	struct xchk_ag {
032d91f9 DW	39	xfs_agnumber_t agno;
032d91f9 DW	40	struct xfs_perag *pag;
b6c1beb9 DW	41
b6c1beb9 DW	42	/* AG btree roots */
032d91f9 DW	43	struct xfs_buf *agf_bp;
	44	struct xfs_buf *agfl_bp;
	45	struct xfs_buf *agi_bp;
b6c1beb9 DW	46
b6c1beb9 DW	47	/* AG btrees */
032d91f9 DW	48	struct xfs_btree_cur *bno_cur;
	49	struct xfs_btree_cur *cnt_cur;
	50	struct xfs_btree_cur *ino_cur;
	51	struct xfs_btree_cur *fino_cur;
	52	struct xfs_btree_cur *rmap_cur;
	53	struct xfs_btree_cur *refc_cur;
b6c1beb9 DW	54	};
b6c1beb9 DW	55
1d8a748a	56	struct xfs_scrub {
a5637186 DW	57	/* General scrub state. */
	58	struct xfs_mount *mp;
	59	struct xfs_scrub_metadata *sm;
c517b3aa	60	const struct xchk_meta_ops *ops;
a5637186 DW	61	struct xfs_trans *tp;
a5637186 DW	62	struct xfs_inode *ip;
eec0482e	63	void *buf;
80e4e126	64	uint ilock_flags;
a5637186	65	bool try_harder;
eb41c93f	66	bool has_quotaofflock;
b6c1beb9 DW	67
b6c1beb9 DW	68	/* State tracking for single-AG operations. */
032d91f9	69	struct xchk_ag sa;
a5637186 DW	70	};
a5637186 DW	71
36fd6e86	72	/* Metadata scrubbers */
1d8a748a DW	73	int xchk_tester(struct xfs_scrub *sc);
	74	int xchk_superblock(struct xfs_scrub *sc);
	75	int xchk_agf(struct xfs_scrub *sc);
	76	int xchk_agfl(struct xfs_scrub *sc);
	77	int xchk_agi(struct xfs_scrub *sc);
	78	int xchk_bnobt(struct xfs_scrub *sc);
	79	int xchk_cntbt(struct xfs_scrub *sc);
	80	int xchk_inobt(struct xfs_scrub *sc);
	81	int xchk_finobt(struct xfs_scrub *sc);
	82	int xchk_rmapbt(struct xfs_scrub *sc);
	83	int xchk_refcountbt(struct xfs_scrub *sc);
	84	int xchk_inode(struct xfs_scrub *sc);
	85	int xchk_bmap_data(struct xfs_scrub *sc);
	86	int xchk_bmap_attr(struct xfs_scrub *sc);
	87	int xchk_bmap_cow(struct xfs_scrub *sc);
	88	int xchk_directory(struct xfs_scrub *sc);
	89	int xchk_xattr(struct xfs_scrub *sc);
	90	int xchk_symlink(struct xfs_scrub *sc);
	91	int xchk_parent(struct xfs_scrub *sc);
29b0767b	92	#ifdef CONFIG_XFS_RT
1d8a748a DW	93	int xchk_rtbitmap(struct xfs_scrub *sc);
1d8a748a DW	94	int xchk_rtsummary(struct xfs_scrub *sc);
29b0767b DW	95	#else
29b0767b DW	96	static inline int
1d8a748a	97	xchk_rtbitmap(struct xfs_scrub *sc)
29b0767b DW	98	{
	99	return -ENOENT;
	100	}
	101	static inline int
1d8a748a	102	xchk_rtsummary(struct xfs_scrub *sc)
29b0767b DW	103	{
	104	return -ENOENT;
	105	}
	106	#endif
c2fc338c	107	#ifdef CONFIG_XFS_QUOTA
1d8a748a	108	int xchk_quota(struct xfs_scrub *sc);
c2fc338c DW	109	#else
c2fc338c DW	110	static inline int
1d8a748a	111	xchk_quota(struct xfs_scrub *sc)
c2fc338c DW	112	{
	113	return -ENOENT;
	114	}
	115	#endif
36fd6e86	116
52dc4b44	117	/* cross-referencing helpers */
032d91f9 DW	118	void xchk_xref_is_used_space(struct xfs_scrub *sc, xfs_agblock_t agbno,
	119	xfs_extlen_t len);
	120	void xchk_xref_is_not_inode_chunk(struct xfs_scrub *sc, xfs_agblock_t agbno,
	121	xfs_extlen_t len);
	122	void xchk_xref_is_inode_chunk(struct xfs_scrub *sc, xfs_agblock_t agbno,
	123	xfs_extlen_t len);
	124	void xchk_xref_is_owned_by(struct xfs_scrub *sc, xfs_agblock_t agbno,
66e3237e	125	xfs_extlen_t len, const struct xfs_owner_info *oinfo);
032d91f9	126	void xchk_xref_is_not_owned_by(struct xfs_scrub *sc, xfs_agblock_t agbno,
66e3237e	127	xfs_extlen_t len, const struct xfs_owner_info *oinfo);
032d91f9 DW	128	void xchk_xref_has_no_owner(struct xfs_scrub *sc, xfs_agblock_t agbno,
	129	xfs_extlen_t len);
	130	void xchk_xref_is_cow_staging(struct xfs_scrub *sc, xfs_agblock_t bno,
	131	xfs_extlen_t len);
	132	void xchk_xref_is_not_shared(struct xfs_scrub *sc, xfs_agblock_t bno,
	133	xfs_extlen_t len);
46d9bfb5	134	#ifdef CONFIG_XFS_RT
032d91f9 DW	135	void xchk_xref_is_used_rt_space(struct xfs_scrub *sc, xfs_rtblock_t rtbno,
032d91f9 DW	136	xfs_extlen_t len);
46d9bfb5	137	#else
c517b3aa	138	# define xchk_xref_is_used_rt_space(sc, rtbno, len) do { } while (0)
46d9bfb5	139	#endif
52dc4b44	140
36fd6e86	141	#endif /* __XFS_SCRUB_SCRUB_H__ */