245 lines · c
1// SPDX-License-Identifier: GPL-2.0-or-later2/*3 * Copyright (C) 2017-2023 Oracle. All Rights Reserved.4 * Author: Darrick J. Wong <djwong@kernel.org>5 */6#ifndef __XFS_SCRUB_COMMON_H__7#define __XFS_SCRUB_COMMON_H__8 9int xchk_trans_alloc(struct xfs_scrub *sc, uint resblks);10int xchk_trans_alloc_empty(struct xfs_scrub *sc);11void xchk_trans_cancel(struct xfs_scrub *sc);12 13bool xchk_process_error(struct xfs_scrub *sc, xfs_agnumber_t agno,14 xfs_agblock_t bno, int *error);15bool xchk_fblock_process_error(struct xfs_scrub *sc, int whichfork,16 xfs_fileoff_t offset, int *error);17 18bool xchk_xref_process_error(struct xfs_scrub *sc,19 xfs_agnumber_t agno, xfs_agblock_t bno, int *error);20bool xchk_fblock_xref_process_error(struct xfs_scrub *sc,21 int whichfork, xfs_fileoff_t offset, int *error);22 23void xchk_block_set_preen(struct xfs_scrub *sc,24 struct xfs_buf *bp);25void xchk_ino_set_preen(struct xfs_scrub *sc, xfs_ino_t ino);26 27void xchk_set_corrupt(struct xfs_scrub *sc);28void xchk_block_set_corrupt(struct xfs_scrub *sc,29 struct xfs_buf *bp);30void xchk_ino_set_corrupt(struct xfs_scrub *sc, xfs_ino_t ino);31void xchk_fblock_set_corrupt(struct xfs_scrub *sc, int whichfork,32 xfs_fileoff_t offset);33#ifdef CONFIG_XFS_QUOTA34void xchk_qcheck_set_corrupt(struct xfs_scrub *sc, unsigned int dqtype,35 xfs_dqid_t id);36#endif37 38void xchk_block_xref_set_corrupt(struct xfs_scrub *sc,39 struct xfs_buf *bp);40void xchk_ino_xref_set_corrupt(struct xfs_scrub *sc,41 xfs_ino_t ino);42void xchk_fblock_xref_set_corrupt(struct xfs_scrub *sc,43 int whichfork, xfs_fileoff_t offset);44 45void xchk_ino_set_warning(struct xfs_scrub *sc, xfs_ino_t ino);46void xchk_fblock_set_warning(struct xfs_scrub *sc, int whichfork,47 xfs_fileoff_t offset);48 49void xchk_set_incomplete(struct xfs_scrub *sc);50int xchk_checkpoint_log(struct xfs_mount *mp);51 52/* Are we set up for a cross-referencing check? */53bool xchk_should_check_xref(struct xfs_scrub *sc, int *error,54 struct xfs_btree_cur **curpp);55 56static inline int xchk_setup_nothing(struct xfs_scrub *sc)57{58 return -ENOENT;59}60 61/* Setup functions */62int xchk_setup_agheader(struct xfs_scrub *sc);63int xchk_setup_fs(struct xfs_scrub *sc);64int xchk_setup_ag_allocbt(struct xfs_scrub *sc);65int xchk_setup_ag_iallocbt(struct xfs_scrub *sc);66int xchk_setup_ag_rmapbt(struct xfs_scrub *sc);67int xchk_setup_ag_refcountbt(struct xfs_scrub *sc);68int xchk_setup_inode(struct xfs_scrub *sc);69int xchk_setup_inode_bmap(struct xfs_scrub *sc);70int xchk_setup_inode_bmap_data(struct xfs_scrub *sc);71int xchk_setup_directory(struct xfs_scrub *sc);72int xchk_setup_xattr(struct xfs_scrub *sc);73int xchk_setup_symlink(struct xfs_scrub *sc);74int xchk_setup_parent(struct xfs_scrub *sc);75int xchk_setup_dirtree(struct xfs_scrub *sc);76#ifdef CONFIG_XFS_RT77int xchk_setup_rtbitmap(struct xfs_scrub *sc);78int xchk_setup_rtsummary(struct xfs_scrub *sc);79#else80# define xchk_setup_rtbitmap xchk_setup_nothing81# define xchk_setup_rtsummary xchk_setup_nothing82#endif83#ifdef CONFIG_XFS_QUOTA84int xchk_ino_dqattach(struct xfs_scrub *sc);85int xchk_setup_quota(struct xfs_scrub *sc);86int xchk_setup_quotacheck(struct xfs_scrub *sc);87#else88static inline int89xchk_ino_dqattach(struct xfs_scrub *sc)90{91 return 0;92}93# define xchk_setup_quota xchk_setup_nothing94# define xchk_setup_quotacheck xchk_setup_nothing95#endif96int xchk_setup_fscounters(struct xfs_scrub *sc);97int xchk_setup_nlinks(struct xfs_scrub *sc);98 99void xchk_ag_free(struct xfs_scrub *sc, struct xchk_ag *sa);100int xchk_ag_init(struct xfs_scrub *sc, xfs_agnumber_t agno,101 struct xchk_ag *sa);102int xchk_perag_drain_and_lock(struct xfs_scrub *sc);103 104/*105 * Grab all AG resources, treating the inability to grab the perag structure as106 * a fs corruption. This is intended for callers checking an ondisk reference107 * to a given AG, which means that the AG must still exist.108 */109static inline int110xchk_ag_init_existing(111 struct xfs_scrub *sc,112 xfs_agnumber_t agno,113 struct xchk_ag *sa)114{115 int error = xchk_ag_init(sc, agno, sa);116 117 return error == -ENOENT ? -EFSCORRUPTED : error;118}119 120int xchk_ag_read_headers(struct xfs_scrub *sc, xfs_agnumber_t agno,121 struct xchk_ag *sa);122void xchk_ag_btcur_free(struct xchk_ag *sa);123void xchk_ag_btcur_init(struct xfs_scrub *sc, struct xchk_ag *sa);124int xchk_count_rmap_ownedby_ag(struct xfs_scrub *sc, struct xfs_btree_cur *cur,125 const struct xfs_owner_info *oinfo, xfs_filblks_t *blocks);126 127int xchk_setup_ag_btree(struct xfs_scrub *sc, bool force_log);128int xchk_iget_for_scrubbing(struct xfs_scrub *sc);129int xchk_setup_inode_contents(struct xfs_scrub *sc, unsigned int resblks);130int xchk_install_live_inode(struct xfs_scrub *sc, struct xfs_inode *ip);131 132void xchk_ilock(struct xfs_scrub *sc, unsigned int ilock_flags);133bool xchk_ilock_nowait(struct xfs_scrub *sc, unsigned int ilock_flags);134void xchk_iunlock(struct xfs_scrub *sc, unsigned int ilock_flags);135 136void xchk_buffer_recheck(struct xfs_scrub *sc, struct xfs_buf *bp);137 138/*139 * Grab the inode at @inum. The caller must have created a scrub transaction140 * so that we can confirm the inumber by walking the inobt and not deadlock on141 * a loop in the inobt.142 */143int xchk_iget(struct xfs_scrub *sc, xfs_ino_t inum, struct xfs_inode **ipp);144int xchk_iget_agi(struct xfs_scrub *sc, xfs_ino_t inum,145 struct xfs_buf **agi_bpp, struct xfs_inode **ipp);146void xchk_irele(struct xfs_scrub *sc, struct xfs_inode *ip);147int xchk_install_handle_inode(struct xfs_scrub *sc, struct xfs_inode *ip);148 149/*150 * Safe version of (untrusted) xchk_iget that uses an empty transaction to151 * avoid deadlocking on loops in the inobt. This should only be used in a152 * scrub or repair setup routine, and only prior to grabbing a transaction.153 */154static inline int155xchk_iget_safe(struct xfs_scrub *sc, xfs_ino_t inum, struct xfs_inode **ipp)156{157 int error;158 159 ASSERT(sc->tp == NULL);160 161 error = xchk_trans_alloc(sc, 0);162 if (error)163 return error;164 error = xchk_iget(sc, inum, ipp);165 xchk_trans_cancel(sc);166 return error;167}168 169/*170 * Don't bother cross-referencing if we already found corruption or cross171 * referencing discrepancies.172 */173static inline bool xchk_skip_xref(struct xfs_scrub_metadata *sm)174{175 return sm->sm_flags & (XFS_SCRUB_OFLAG_CORRUPT |176 XFS_SCRUB_OFLAG_XCORRUPT);177}178 179bool xchk_dir_looks_zapped(struct xfs_inode *dp);180bool xchk_pptr_looks_zapped(struct xfs_inode *ip);181 182#ifdef CONFIG_XFS_ONLINE_REPAIR183/* Decide if a repair is required. */184static inline bool xchk_needs_repair(const struct xfs_scrub_metadata *sm)185{186 return sm->sm_flags & (XFS_SCRUB_OFLAG_CORRUPT |187 XFS_SCRUB_OFLAG_XCORRUPT |188 XFS_SCRUB_OFLAG_PREEN);189}190 191/*192 * "Should we prepare for a repair?"193 *194 * Return true if the caller permits us to repair metadata and we're not195 * setting up for a post-repair evaluation.196 */197static inline bool xchk_could_repair(const struct xfs_scrub *sc)198{199 return (sc->sm->sm_flags & XFS_SCRUB_IFLAG_REPAIR) &&200 !(sc->flags & XREP_ALREADY_FIXED);201}202#else203# define xchk_needs_repair(sc) (false)204# define xchk_could_repair(sc) (false)205#endif /* CONFIG_XFS_ONLINE_REPAIR */206 207int xchk_metadata_inode_forks(struct xfs_scrub *sc);208 209/*210 * Helper macros to allocate and format xfile description strings.211 * Callers must kfree the pointer returned.212 */213#define xchk_xfile_descr(sc, fmt, ...) \214 kasprintf(XCHK_GFP_FLAGS, "XFS (%s): " fmt, \215 (sc)->mp->m_super->s_id, ##__VA_ARGS__)216#define xchk_xfile_ag_descr(sc, fmt, ...) \217 kasprintf(XCHK_GFP_FLAGS, "XFS (%s): AG 0x%x " fmt, \218 (sc)->mp->m_super->s_id, \219 (sc)->sa.pag ? (sc)->sa.pag->pag_agno : (sc)->sm->sm_agno, \220 ##__VA_ARGS__)221#define xchk_xfile_ino_descr(sc, fmt, ...) \222 kasprintf(XCHK_GFP_FLAGS, "XFS (%s): inode 0x%llx " fmt, \223 (sc)->mp->m_super->s_id, \224 (sc)->ip ? (sc)->ip->i_ino : (sc)->sm->sm_ino, \225 ##__VA_ARGS__)226 227/*228 * Setting up a hook to wait for intents to drain is costly -- we have to take229 * the CPU hotplug lock and force an i-cache flush on all CPUs once to set it230 * up, and again to tear it down. These costs add up quickly, so we only want231 * to enable the drain waiter if the drain actually detected a conflict with232 * running intent chains.233 */234static inline bool xchk_need_intent_drain(struct xfs_scrub *sc)235{236 return sc->flags & XCHK_NEED_DRAIN;237}238 239void xchk_fsgates_enable(struct xfs_scrub *sc, unsigned int scrub_fshooks);240 241int xchk_inode_is_allocated(struct xfs_scrub *sc, xfs_agino_t agino,242 bool *inuse);243 244#endif /* __XFS_SCRUB_COMMON_H__ */245