xref: /linux/fs/xfs/scrub/common.h (revision 6a61b70b43c9c4cbc7314bf6c8b5ba8b0d6e1e7b)
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 int xfs_scrub_trans_alloc(struct xfs_scrub_context *sc, uint resblks);
42 bool xfs_scrub_process_error(struct xfs_scrub_context *sc, xfs_agnumber_t agno,
43 		xfs_agblock_t bno, int *error);
44 bool xfs_scrub_fblock_process_error(struct xfs_scrub_context *sc, int whichfork,
45 		xfs_fileoff_t offset, int *error);
46 
47 bool xfs_scrub_xref_process_error(struct xfs_scrub_context *sc,
48 		xfs_agnumber_t agno, xfs_agblock_t bno, int *error);
49 bool xfs_scrub_fblock_xref_process_error(struct xfs_scrub_context *sc,
50 		int whichfork, xfs_fileoff_t offset, int *error);
51 
52 void xfs_scrub_block_set_preen(struct xfs_scrub_context *sc,
53 		struct xfs_buf *bp);
54 void xfs_scrub_ino_set_preen(struct xfs_scrub_context *sc, xfs_ino_t ino);
55 
56 void xfs_scrub_block_set_corrupt(struct xfs_scrub_context *sc,
57 		struct xfs_buf *bp);
58 void xfs_scrub_ino_set_corrupt(struct xfs_scrub_context *sc, xfs_ino_t ino);
59 void xfs_scrub_fblock_set_corrupt(struct xfs_scrub_context *sc, int whichfork,
60 		xfs_fileoff_t offset);
61 
62 void xfs_scrub_block_xref_set_corrupt(struct xfs_scrub_context *sc,
63 		struct xfs_buf *bp);
64 void xfs_scrub_ino_xref_set_corrupt(struct xfs_scrub_context *sc,
65 		xfs_ino_t ino);
66 void xfs_scrub_fblock_xref_set_corrupt(struct xfs_scrub_context *sc,
67 		int whichfork, xfs_fileoff_t offset);
68 
69 void xfs_scrub_ino_set_warning(struct xfs_scrub_context *sc, xfs_ino_t ino);
70 void xfs_scrub_fblock_set_warning(struct xfs_scrub_context *sc, int whichfork,
71 		xfs_fileoff_t offset);
72 
73 void xfs_scrub_set_incomplete(struct xfs_scrub_context *sc);
74 int xfs_scrub_checkpoint_log(struct xfs_mount *mp);
75 
76 /* Are we set up for a cross-referencing check? */
77 bool xfs_scrub_should_check_xref(struct xfs_scrub_context *sc, int *error,
78 			   struct xfs_btree_cur **curpp);
79 
80 /* Setup functions */
81 int xfs_scrub_setup_fs(struct xfs_scrub_context *sc, struct xfs_inode *ip);
82 int xfs_scrub_setup_ag_allocbt(struct xfs_scrub_context *sc,
83 			       struct xfs_inode *ip);
84 int xfs_scrub_setup_ag_iallocbt(struct xfs_scrub_context *sc,
85 				struct xfs_inode *ip);
86 int xfs_scrub_setup_ag_rmapbt(struct xfs_scrub_context *sc,
87 			      struct xfs_inode *ip);
88 int xfs_scrub_setup_ag_refcountbt(struct xfs_scrub_context *sc,
89 				  struct xfs_inode *ip);
90 int xfs_scrub_setup_inode(struct xfs_scrub_context *sc,
91 			  struct xfs_inode *ip);
92 int xfs_scrub_setup_inode_bmap(struct xfs_scrub_context *sc,
93 			       struct xfs_inode *ip);
94 int xfs_scrub_setup_inode_bmap_data(struct xfs_scrub_context *sc,
95 				    struct xfs_inode *ip);
96 int xfs_scrub_setup_directory(struct xfs_scrub_context *sc,
97 			      struct xfs_inode *ip);
98 int xfs_scrub_setup_xattr(struct xfs_scrub_context *sc,
99 			  struct xfs_inode *ip);
100 int xfs_scrub_setup_symlink(struct xfs_scrub_context *sc,
101 			    struct xfs_inode *ip);
102 int xfs_scrub_setup_parent(struct xfs_scrub_context *sc,
103 			   struct xfs_inode *ip);
104 #ifdef CONFIG_XFS_RT
105 int xfs_scrub_setup_rt(struct xfs_scrub_context *sc, struct xfs_inode *ip);
106 #else
107 static inline int
108 xfs_scrub_setup_rt(struct xfs_scrub_context *sc, struct xfs_inode *ip)
109 {
110 	return -ENOENT;
111 }
112 #endif
113 #ifdef CONFIG_XFS_QUOTA
114 int xfs_scrub_setup_quota(struct xfs_scrub_context *sc, struct xfs_inode *ip);
115 #else
116 static inline int
117 xfs_scrub_setup_quota(struct xfs_scrub_context *sc, struct xfs_inode *ip)
118 {
119 	return -ENOENT;
120 }
121 #endif
122 
123 void xfs_scrub_ag_free(struct xfs_scrub_context *sc, struct xfs_scrub_ag *sa);
124 int xfs_scrub_ag_init(struct xfs_scrub_context *sc, xfs_agnumber_t agno,
125 		      struct xfs_scrub_ag *sa);
126 void xfs_scrub_perag_get(struct xfs_mount *mp, struct xfs_scrub_ag *sa);
127 int xfs_scrub_ag_read_headers(struct xfs_scrub_context *sc, xfs_agnumber_t agno,
128 			      struct xfs_buf **agi, struct xfs_buf **agf,
129 			      struct xfs_buf **agfl);
130 void xfs_scrub_ag_btcur_free(struct xfs_scrub_ag *sa);
131 int xfs_scrub_ag_btcur_init(struct xfs_scrub_context *sc,
132 			    struct xfs_scrub_ag *sa);
133 int xfs_scrub_count_rmap_ownedby_ag(struct xfs_scrub_context *sc,
134 				    struct xfs_btree_cur *cur,
135 				    struct xfs_owner_info *oinfo,
136 				    xfs_filblks_t *blocks);
137 
138 int xfs_scrub_setup_ag_btree(struct xfs_scrub_context *sc,
139 			     struct xfs_inode *ip, bool force_log);
140 int xfs_scrub_get_inode(struct xfs_scrub_context *sc, struct xfs_inode *ip_in);
141 int xfs_scrub_setup_inode_contents(struct xfs_scrub_context *sc,
142 				   struct xfs_inode *ip, unsigned int resblks);
143 void xfs_scrub_buffer_recheck(struct xfs_scrub_context *sc, struct xfs_buf *bp);
144 
145 /*
146  * Don't bother cross-referencing if we already found corruption or cross
147  * referencing discrepancies.
148  */
149 static inline bool xfs_scrub_skip_xref(struct xfs_scrub_metadata *sm)
150 {
151 	return sm->sm_flags & (XFS_SCRUB_OFLAG_CORRUPT |
152 			       XFS_SCRUB_OFLAG_XCORRUPT);
153 }
154 
155 int xfs_scrub_metadata_inode_forks(struct xfs_scrub_context *sc);
156 int xfs_scrub_ilock_inverted(struct xfs_inode *ip, uint lock_mode);
157 
158 #endif	/* __XFS_SCRUB_COMMON_H__ */
159