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