xref: /openbmc/linux/fs/xfs/scrub/common.h (revision 99a15348)
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  */
14 static inline bool
15 xchk_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 
34 int xchk_trans_alloc(struct xfs_scrub *sc, uint resblks);
35 bool xchk_process_error(struct xfs_scrub *sc, xfs_agnumber_t agno,
36 		xfs_agblock_t bno, int *error);
37 bool xchk_fblock_process_error(struct xfs_scrub *sc, int whichfork,
38 		xfs_fileoff_t offset, int *error);
39 
40 bool xchk_xref_process_error(struct xfs_scrub *sc,
41 		xfs_agnumber_t agno, xfs_agblock_t bno, int *error);
42 bool xchk_fblock_xref_process_error(struct xfs_scrub *sc,
43 		int whichfork, xfs_fileoff_t offset, int *error);
44 
45 void xchk_block_set_preen(struct xfs_scrub *sc,
46 		struct xfs_buf *bp);
47 void xchk_ino_set_preen(struct xfs_scrub *sc, xfs_ino_t ino);
48 
49 void xchk_set_corrupt(struct xfs_scrub *sc);
50 void xchk_block_set_corrupt(struct xfs_scrub *sc,
51 		struct xfs_buf *bp);
52 void xchk_ino_set_corrupt(struct xfs_scrub *sc, xfs_ino_t ino);
53 void xchk_fblock_set_corrupt(struct xfs_scrub *sc, int whichfork,
54 		xfs_fileoff_t offset);
55 
56 void xchk_block_xref_set_corrupt(struct xfs_scrub *sc,
57 		struct xfs_buf *bp);
58 void xchk_ino_xref_set_corrupt(struct xfs_scrub *sc,
59 		xfs_ino_t ino);
60 void xchk_fblock_xref_set_corrupt(struct xfs_scrub *sc,
61 		int whichfork, xfs_fileoff_t offset);
62 
63 void xchk_ino_set_warning(struct xfs_scrub *sc, xfs_ino_t ino);
64 void xchk_fblock_set_warning(struct xfs_scrub *sc, int whichfork,
65 		xfs_fileoff_t offset);
66 
67 void xchk_set_incomplete(struct xfs_scrub *sc);
68 int xchk_checkpoint_log(struct xfs_mount *mp);
69 
70 /* Are we set up for a cross-referencing check? */
71 bool xchk_should_check_xref(struct xfs_scrub *sc, int *error,
72 			   struct xfs_btree_cur **curpp);
73 
74 /* Setup functions */
75 int xchk_setup_fs(struct xfs_scrub *sc);
76 int xchk_setup_ag_allocbt(struct xfs_scrub *sc);
77 int xchk_setup_ag_iallocbt(struct xfs_scrub *sc);
78 int xchk_setup_ag_rmapbt(struct xfs_scrub *sc);
79 int xchk_setup_ag_refcountbt(struct xfs_scrub *sc);
80 int xchk_setup_inode(struct xfs_scrub *sc);
81 int xchk_setup_inode_bmap(struct xfs_scrub *sc);
82 int xchk_setup_inode_bmap_data(struct xfs_scrub *sc);
83 int xchk_setup_directory(struct xfs_scrub *sc);
84 int xchk_setup_xattr(struct xfs_scrub *sc);
85 int xchk_setup_symlink(struct xfs_scrub *sc);
86 int xchk_setup_parent(struct xfs_scrub *sc);
87 #ifdef CONFIG_XFS_RT
88 int xchk_setup_rt(struct xfs_scrub *sc);
89 #else
90 static inline int
91 xchk_setup_rt(struct xfs_scrub *sc)
92 {
93 	return -ENOENT;
94 }
95 #endif
96 #ifdef CONFIG_XFS_QUOTA
97 int xchk_setup_quota(struct xfs_scrub *sc);
98 #else
99 static inline int
100 xchk_setup_quota(struct xfs_scrub *sc)
101 {
102 	return -ENOENT;
103 }
104 #endif
105 int xchk_setup_fscounters(struct xfs_scrub *sc);
106 
107 void xchk_ag_free(struct xfs_scrub *sc, struct xchk_ag *sa);
108 int xchk_ag_init(struct xfs_scrub *sc, xfs_agnumber_t agno,
109 		struct xchk_ag *sa);
110 
111 /*
112  * Grab all AG resources, treating the inability to grab the perag structure as
113  * a fs corruption.  This is intended for callers checking an ondisk reference
114  * to a given AG, which means that the AG must still exist.
115  */
116 static inline int
117 xchk_ag_init_existing(
118 	struct xfs_scrub	*sc,
119 	xfs_agnumber_t		agno,
120 	struct xchk_ag		*sa)
121 {
122 	int			error = xchk_ag_init(sc, agno, sa);
123 
124 	return error == -ENOENT ? -EFSCORRUPTED : error;
125 }
126 
127 int xchk_ag_read_headers(struct xfs_scrub *sc, xfs_agnumber_t agno,
128 		struct xchk_ag *sa);
129 void xchk_ag_btcur_free(struct xchk_ag *sa);
130 void xchk_ag_btcur_init(struct xfs_scrub *sc, struct xchk_ag *sa);
131 int xchk_count_rmap_ownedby_ag(struct xfs_scrub *sc, struct xfs_btree_cur *cur,
132 		const struct xfs_owner_info *oinfo, xfs_filblks_t *blocks);
133 
134 int xchk_setup_ag_btree(struct xfs_scrub *sc, bool force_log);
135 int xchk_get_inode(struct xfs_scrub *sc);
136 int xchk_setup_inode_contents(struct xfs_scrub *sc, unsigned int resblks);
137 void xchk_buffer_recheck(struct xfs_scrub *sc, struct xfs_buf *bp);
138 
139 /*
140  * Don't bother cross-referencing if we already found corruption or cross
141  * referencing discrepancies.
142  */
143 static inline bool xchk_skip_xref(struct xfs_scrub_metadata *sm)
144 {
145 	return sm->sm_flags & (XFS_SCRUB_OFLAG_CORRUPT |
146 			       XFS_SCRUB_OFLAG_XCORRUPT);
147 }
148 
149 int xchk_metadata_inode_forks(struct xfs_scrub *sc);
150 int xchk_ilock_inverted(struct xfs_inode *ip, uint lock_mode);
151 void xchk_stop_reaping(struct xfs_scrub *sc);
152 void xchk_start_reaping(struct xfs_scrub *sc);
153 
154 #endif	/* __XFS_SCRUB_COMMON_H__ */
155