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_SCRUB_H__
7 #define __XFS_SCRUB_SCRUB_H__
8
9 struct xfs_scrub;
10
11 /* Type info and names for the scrub types. */
12 enum xchk_type {
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
19 struct xchk_meta_ops {
20 /* Acquire whatever resources are needed for the operation. */
21 int (*setup)(struct xfs_scrub *,
22 struct xfs_inode *);
23
24 /* Examine metadata for errors. */
25 int (*scrub)(struct xfs_scrub *);
26
27 /* Repair or optimize the metadata. */
28 int (*repair)(struct xfs_scrub *);
29
30 /* Decide if we even have this piece of metadata. */
31 bool (*has)(struct xfs_sb *);
32
33 /* type describing required/allowed inputs */
34 enum xchk_type type;
35 };
36
37 /* Buffer pointers and btree cursors for an entire AG. */
38 struct xchk_ag {
39 xfs_agnumber_t agno;
40 struct xfs_perag *pag;
41
42 /* AG btree roots */
43 struct xfs_buf *agf_bp;
44 struct xfs_buf *agfl_bp;
45 struct xfs_buf *agi_bp;
46
47 /* AG btrees */
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;
54 };
55
56 struct xfs_scrub {
57 /* General scrub state. */
58 struct xfs_mount *mp;
59 struct xfs_scrub_metadata *sm;
60 const struct xchk_meta_ops *ops;
61 struct xfs_trans *tp;
62 struct xfs_inode *ip;
63 void *buf;
64 uint ilock_flags;
65 bool try_harder;
66 bool has_quotaofflock;
67
68 /* State tracking for single-AG operations. */
69 struct xchk_ag sa;
70 };
71
72 /* Metadata scrubbers */
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);
92 #ifdef CONFIG_XFS_RT
93 int xchk_rtbitmap(struct xfs_scrub *sc);
94 int xchk_rtsummary(struct xfs_scrub *sc);
95 #else
96 static inline int
xchk_rtbitmap(struct xfs_scrub * sc)97 xchk_rtbitmap(struct xfs_scrub *sc)
98 {
99 return -ENOENT;
100 }
101 static inline int
xchk_rtsummary(struct xfs_scrub * sc)102 xchk_rtsummary(struct xfs_scrub *sc)
103 {
104 return -ENOENT;
105 }
106 #endif
107 #ifdef CONFIG_XFS_QUOTA
108 int xchk_quota(struct xfs_scrub *sc);
109 #else
110 static inline int
xchk_quota(struct xfs_scrub * sc)111 xchk_quota(struct xfs_scrub *sc)
112 {
113 return -ENOENT;
114 }
115 #endif
116
117 /* cross-referencing helpers */
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,
125 xfs_extlen_t len, struct xfs_owner_info *oinfo);
126 void xchk_xref_is_not_owned_by(struct xfs_scrub *sc, xfs_agblock_t agbno,
127 xfs_extlen_t len, struct xfs_owner_info *oinfo);
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);
134 #ifdef CONFIG_XFS_RT
135 void xchk_xref_is_used_rt_space(struct xfs_scrub *sc, xfs_rtblock_t rtbno,
136 xfs_extlen_t len);
137 #else
138 # define xchk_xref_is_used_rt_space(sc, rtbno, len) do { } while (0)
139 #endif
140
141 #endif /* __XFS_SCRUB_SCRUB_H__ */
142