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_COMMON_H__
  7#define __XFS_SCRUB_COMMON_H__
  8
  9/*
 10 * We /could/ terminate a scrub/repair operation early.  If we're not
 11 * in a good place to continue (fatal signal, etc.) then bail out.
 12 * Note that we're careful not to make any judgements about *error.
 13 */
 14static inline bool
 15xchk_should_terminate(
 16	struct xfs_scrub	*sc,
 17	int			*error)
 18{
 19	/*
 20	 * If preemption is disabled, we need to yield to the scheduler every
 21	 * few seconds so that we don't run afoul of the soft lockup watchdog
 22	 * or RCU stall detector.
 23	 */
 24	cond_resched();
 25
 26	if (fatal_signal_pending(current)) {
 27		if (*error == 0)
 28			*error = -EAGAIN;
 29		return true;
 30	}
 31	return false;
 32}
 33
 34int xchk_trans_alloc(struct xfs_scrub *sc, uint resblks);
 35bool xchk_process_error(struct xfs_scrub *sc, xfs_agnumber_t agno,
 36		xfs_agblock_t bno, int *error);
 37bool xchk_fblock_process_error(struct xfs_scrub *sc, int whichfork,
 38		xfs_fileoff_t offset, int *error);
 39
 40bool xchk_xref_process_error(struct xfs_scrub *sc,
 41		xfs_agnumber_t agno, xfs_agblock_t bno, int *error);
 42bool xchk_fblock_xref_process_error(struct xfs_scrub *sc,
 43		int whichfork, xfs_fileoff_t offset, int *error);
 44
 45void xchk_block_set_preen(struct xfs_scrub *sc,
 46		struct xfs_buf *bp);
 47void xchk_ino_set_preen(struct xfs_scrub *sc, xfs_ino_t ino);
 48
 49void xchk_set_corrupt(struct xfs_scrub *sc);
 50void xchk_block_set_corrupt(struct xfs_scrub *sc,
 51		struct xfs_buf *bp);
 52void xchk_ino_set_corrupt(struct xfs_scrub *sc, xfs_ino_t ino);
 53void xchk_fblock_set_corrupt(struct xfs_scrub *sc, int whichfork,
 54		xfs_fileoff_t offset);
 55
 56void xchk_block_xref_set_corrupt(struct xfs_scrub *sc,
 57		struct xfs_buf *bp);
 58void xchk_ino_xref_set_corrupt(struct xfs_scrub *sc,
 59		xfs_ino_t ino);
 60void xchk_fblock_xref_set_corrupt(struct xfs_scrub *sc,
 61		int whichfork, xfs_fileoff_t offset);
 62
 63void xchk_ino_set_warning(struct xfs_scrub *sc, xfs_ino_t ino);
 64void xchk_fblock_set_warning(struct xfs_scrub *sc, int whichfork,
 65		xfs_fileoff_t offset);
 66
 67void xchk_set_incomplete(struct xfs_scrub *sc);
 68int xchk_checkpoint_log(struct xfs_mount *mp);
 69
 70/* Are we set up for a cross-referencing check? */
 71bool xchk_should_check_xref(struct xfs_scrub *sc, int *error,
 72			   struct xfs_btree_cur **curpp);
 73
 74/* Setup functions */
 75int xchk_setup_fs(struct xfs_scrub *sc);
 76int xchk_setup_ag_allocbt(struct xfs_scrub *sc);
 77int xchk_setup_ag_iallocbt(struct xfs_scrub *sc);
 78int xchk_setup_ag_rmapbt(struct xfs_scrub *sc);
 79int xchk_setup_ag_refcountbt(struct xfs_scrub *sc);
 80int xchk_setup_inode(struct xfs_scrub *sc);
 81int xchk_setup_inode_bmap(struct xfs_scrub *sc);
 82int xchk_setup_inode_bmap_data(struct xfs_scrub *sc);
 83int xchk_setup_directory(struct xfs_scrub *sc);
 84int xchk_setup_xattr(struct xfs_scrub *sc);
 85int xchk_setup_symlink(struct xfs_scrub *sc);
 86int xchk_setup_parent(struct xfs_scrub *sc);
 87#ifdef CONFIG_XFS_RT
 88int xchk_setup_rt(struct xfs_scrub *sc);
 89#else
 90static inline int
 91xchk_setup_rt(struct xfs_scrub *sc)
 92{
 93	return -ENOENT;
 94}
 95#endif
 96#ifdef CONFIG_XFS_QUOTA
 97int xchk_setup_quota(struct xfs_scrub *sc);
 98#else
 99static inline int
100xchk_setup_quota(struct xfs_scrub *sc)
101{
102	return -ENOENT;
103}
104#endif
105int xchk_setup_fscounters(struct xfs_scrub *sc);
106
107void xchk_ag_free(struct xfs_scrub *sc, struct xchk_ag *sa);
108int xchk_ag_init(struct xfs_scrub *sc, xfs_agnumber_t agno,
109		struct xchk_ag *sa);
110void xchk_perag_get(struct xfs_mount *mp, struct xchk_ag *sa);
111int xchk_ag_read_headers(struct xfs_scrub *sc, xfs_agnumber_t agno,
112		struct xchk_ag *sa);
113void xchk_ag_btcur_free(struct xchk_ag *sa);
114void xchk_ag_btcur_init(struct xfs_scrub *sc, struct xchk_ag *sa);
115int xchk_count_rmap_ownedby_ag(struct xfs_scrub *sc, struct xfs_btree_cur *cur,
116		const struct xfs_owner_info *oinfo, xfs_filblks_t *blocks);
117
118int xchk_setup_ag_btree(struct xfs_scrub *sc, bool force_log);
119int xchk_get_inode(struct xfs_scrub *sc);
120int xchk_setup_inode_contents(struct xfs_scrub *sc, unsigned int resblks);
121void xchk_buffer_recheck(struct xfs_scrub *sc, struct xfs_buf *bp);
122
123/*
124 * Don't bother cross-referencing if we already found corruption or cross
125 * referencing discrepancies.
126 */
127static inline bool xchk_skip_xref(struct xfs_scrub_metadata *sm)
128{
129	return sm->sm_flags & (XFS_SCRUB_OFLAG_CORRUPT |
130			       XFS_SCRUB_OFLAG_XCORRUPT);
131}
132
133int xchk_metadata_inode_forks(struct xfs_scrub *sc);
134int xchk_ilock_inverted(struct xfs_inode *ip, uint lock_mode);
135void xchk_stop_reaping(struct xfs_scrub *sc);
136void xchk_start_reaping(struct xfs_scrub *sc);
137
138#endif	/* __XFS_SCRUB_COMMON_H__ */