xfs: scrub refcount btrees
[linux-2.6-block.git] / fs / xfs / scrub / common.h
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
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
59 void xfs_scrub_block_set_preen(struct xfs_scrub_context *sc,
60                 struct xfs_buf *bp);
61 void xfs_scrub_ino_set_preen(struct xfs_scrub_context *sc, struct xfs_buf *bp);
62
63 void xfs_scrub_block_set_corrupt(struct xfs_scrub_context *sc,
64                 struct xfs_buf *bp);
65 void xfs_scrub_ino_set_corrupt(struct xfs_scrub_context *sc, xfs_ino_t ino,
66                 struct xfs_buf *bp);
67 void xfs_scrub_fblock_set_corrupt(struct xfs_scrub_context *sc, int whichfork,
68                 xfs_fileoff_t offset);
69
70 void xfs_scrub_ino_set_warning(struct xfs_scrub_context *sc,
71                 struct xfs_buf *bp);
72 void xfs_scrub_fblock_set_warning(struct xfs_scrub_context *sc, int whichfork,
73                 xfs_fileoff_t offset);
74
75 void xfs_scrub_set_incomplete(struct xfs_scrub_context *sc);
76 int xfs_scrub_checkpoint_log(struct xfs_mount *mp);
77
78 /* Setup functions */
79 int xfs_scrub_setup_fs(struct xfs_scrub_context *sc, struct xfs_inode *ip);
80 int xfs_scrub_setup_ag_header(struct xfs_scrub_context *sc,
81                               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
91
92 void xfs_scrub_ag_free(struct xfs_scrub_context *sc, struct xfs_scrub_ag *sa);
93 int xfs_scrub_ag_init(struct xfs_scrub_context *sc, xfs_agnumber_t agno,
94                       struct xfs_scrub_ag *sa);
95 int xfs_scrub_ag_read_headers(struct xfs_scrub_context *sc, xfs_agnumber_t agno,
96                               struct xfs_buf **agi, struct xfs_buf **agf,
97                               struct xfs_buf **agfl);
98 void xfs_scrub_ag_btcur_free(struct xfs_scrub_ag *sa);
99 int xfs_scrub_ag_btcur_init(struct xfs_scrub_context *sc,
100                             struct xfs_scrub_ag *sa);
101 int xfs_scrub_walk_agfl(struct xfs_scrub_context *sc,
102                         int (*fn)(struct xfs_scrub_context *, xfs_agblock_t bno,
103                                   void *),
104                         void *priv);
105
106 int xfs_scrub_setup_ag_btree(struct xfs_scrub_context *sc,
107                              struct xfs_inode *ip, bool force_log);
108
109 #endif  /* __XFS_SCRUB_COMMON_H__ */