1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 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 9 /* 10 * We /could/ terminate a scrub/repair operation early. If we're not 11 * in a good place to continue (fatal signal, etc.) then bail out. 12 * Note that we're careful not to make any judgements about *error. 13 */ 14 static inline bool 15 xchk_should_terminate( 16 struct xfs_scrub *sc, 17 int *error) 18 { 19 /* 20 * If preemption is disabled, we need to yield to the scheduler every 21 * few seconds so that we don't run afoul of the soft lockup watchdog 22 * or RCU stall detector. 23 */ 24 cond_resched(); 25 26 if (fatal_signal_pending(current)) { 27 if (*error == 0) 28 *error = -EINTR; 29 return true; 30 } 31 return false; 32 } 33 34 int xchk_trans_alloc(struct xfs_scrub *sc, uint resblks); 35 int xchk_trans_alloc_empty(struct xfs_scrub *sc); 36 void xchk_trans_cancel(struct xfs_scrub *sc); 37 38 bool xchk_process_error(struct xfs_scrub *sc, xfs_agnumber_t agno, 39 xfs_agblock_t bno, int *error); 40 bool xchk_fblock_process_error(struct xfs_scrub *sc, int whichfork, 41 xfs_fileoff_t offset, int *error); 42 43 bool xchk_xref_process_error(struct xfs_scrub *sc, 44 xfs_agnumber_t agno, xfs_agblock_t bno, int *error); 45 bool xchk_fblock_xref_process_error(struct xfs_scrub *sc, 46 int whichfork, xfs_fileoff_t offset, int *error); 47 48 void xchk_block_set_preen(struct xfs_scrub *sc, 49 struct xfs_buf *bp); 50 void xchk_ino_set_preen(struct xfs_scrub *sc, xfs_ino_t ino); 51 52 void xchk_set_corrupt(struct xfs_scrub *sc); 53 void xchk_block_set_corrupt(struct xfs_scrub *sc, 54 struct xfs_buf *bp); 55 void xchk_ino_set_corrupt(struct xfs_scrub *sc, xfs_ino_t ino); 56 void xchk_fblock_set_corrupt(struct xfs_scrub *sc, int whichfork, 57 xfs_fileoff_t offset); 58 #ifdef CONFIG_XFS_QUOTA 59 void xchk_qcheck_set_corrupt(struct xfs_scrub *sc, unsigned int dqtype, 60 xfs_dqid_t id); 61 #endif 62 63 void xchk_block_xref_set_corrupt(struct xfs_scrub *sc, 64 struct xfs_buf *bp); 65 void xchk_ino_xref_set_corrupt(struct xfs_scrub *sc, 66 xfs_ino_t ino); 67 void xchk_fblock_xref_set_corrupt(struct xfs_scrub *sc, 68 int whichfork, xfs_fileoff_t offset); 69 70 void xchk_ino_set_warning(struct xfs_scrub *sc, xfs_ino_t ino); 71 void xchk_fblock_set_warning(struct xfs_scrub *sc, int whichfork, 72 xfs_fileoff_t offset); 73 74 void xchk_set_incomplete(struct xfs_scrub *sc); 75 int xchk_checkpoint_log(struct xfs_mount *mp); 76 77 /* Are we set up for a cross-referencing check? */ 78 bool xchk_should_check_xref(struct xfs_scrub *sc, int *error, 79 struct xfs_btree_cur **curpp); 80 81 /* Setup functions */ 82 int xchk_setup_agheader(struct xfs_scrub *sc); 83 int xchk_setup_fs(struct xfs_scrub *sc); 84 int xchk_setup_ag_allocbt(struct xfs_scrub *sc); 85 int xchk_setup_ag_iallocbt(struct xfs_scrub *sc); 86 int xchk_setup_ag_rmapbt(struct xfs_scrub *sc); 87 int xchk_setup_ag_refcountbt(struct xfs_scrub *sc); 88 int xchk_setup_inode(struct xfs_scrub *sc); 89 int xchk_setup_inode_bmap(struct xfs_scrub *sc); 90 int xchk_setup_inode_bmap_data(struct xfs_scrub *sc); 91 int xchk_setup_directory(struct xfs_scrub *sc); 92 int xchk_setup_xattr(struct xfs_scrub *sc); 93 int xchk_setup_symlink(struct xfs_scrub *sc); 94 int xchk_setup_parent(struct xfs_scrub *sc); 95 #ifdef CONFIG_XFS_RT 96 int xchk_setup_rtbitmap(struct xfs_scrub *sc); 97 int xchk_setup_rtsummary(struct xfs_scrub *sc); 98 #else 99 static inline int 100 xchk_setup_rtbitmap(struct xfs_scrub *sc) 101 { 102 return -ENOENT; 103 } 104 static inline int 105 xchk_setup_rtsummary(struct xfs_scrub *sc) 106 { 107 return -ENOENT; 108 } 109 #endif 110 #ifdef CONFIG_XFS_QUOTA 111 int xchk_ino_dqattach(struct xfs_scrub *sc); 112 int xchk_setup_quota(struct xfs_scrub *sc); 113 int xchk_setup_quotacheck(struct xfs_scrub *sc); 114 #else 115 static inline int 116 xchk_ino_dqattach(struct xfs_scrub *sc) 117 { 118 return 0; 119 } 120 static inline int 121 xchk_setup_quota(struct xfs_scrub *sc) 122 { 123 return -ENOENT; 124 } 125 static inline int 126 xchk_setup_quotacheck(struct xfs_scrub *sc) 127 { 128 return -ENOENT; 129 } 130 #endif 131 int xchk_setup_fscounters(struct xfs_scrub *sc); 132 int xchk_setup_nlinks(struct xfs_scrub *sc); 133 134 void xchk_ag_free(struct xfs_scrub *sc, struct xchk_ag *sa); 135 int xchk_ag_init(struct xfs_scrub *sc, xfs_agnumber_t agno, 136 struct xchk_ag *sa); 137 138 /* 139 * Grab all AG resources, treating the inability to grab the perag structure as 140 * a fs corruption. This is intended for callers checking an ondisk reference 141 * to a given AG, which means that the AG must still exist. 142 */ 143 static inline int 144 xchk_ag_init_existing( 145 struct xfs_scrub *sc, 146 xfs_agnumber_t agno, 147 struct xchk_ag *sa) 148 { 149 int error = xchk_ag_init(sc, agno, sa); 150 151 return error == -ENOENT ? -EFSCORRUPTED : error; 152 } 153 154 int xchk_ag_read_headers(struct xfs_scrub *sc, xfs_agnumber_t agno, 155 struct xchk_ag *sa); 156 void xchk_ag_btcur_free(struct xchk_ag *sa); 157 void xchk_ag_btcur_init(struct xfs_scrub *sc, struct xchk_ag *sa); 158 int xchk_count_rmap_ownedby_ag(struct xfs_scrub *sc, struct xfs_btree_cur *cur, 159 const struct xfs_owner_info *oinfo, xfs_filblks_t *blocks); 160 161 int xchk_setup_ag_btree(struct xfs_scrub *sc, bool force_log); 162 int xchk_iget_for_scrubbing(struct xfs_scrub *sc); 163 int xchk_setup_inode_contents(struct xfs_scrub *sc, unsigned int resblks); 164 int xchk_install_live_inode(struct xfs_scrub *sc, struct xfs_inode *ip); 165 166 void xchk_ilock(struct xfs_scrub *sc, unsigned int ilock_flags); 167 bool xchk_ilock_nowait(struct xfs_scrub *sc, unsigned int ilock_flags); 168 void xchk_iunlock(struct xfs_scrub *sc, unsigned int ilock_flags); 169 170 void xchk_buffer_recheck(struct xfs_scrub *sc, struct xfs_buf *bp); 171 172 /* 173 * Grab the inode at @inum. The caller must have created a scrub transaction 174 * so that we can confirm the inumber by walking the inobt and not deadlock on 175 * a loop in the inobt. 176 */ 177 int xchk_iget(struct xfs_scrub *sc, xfs_ino_t inum, struct xfs_inode **ipp); 178 int xchk_iget_agi(struct xfs_scrub *sc, xfs_ino_t inum, 179 struct xfs_buf **agi_bpp, struct xfs_inode **ipp); 180 void xchk_irele(struct xfs_scrub *sc, struct xfs_inode *ip); 181 int xchk_install_handle_inode(struct xfs_scrub *sc, struct xfs_inode *ip); 182 183 /* 184 * Safe version of (untrusted) xchk_iget that uses an empty transaction to 185 * avoid deadlocking on loops in the inobt. This should only be used in a 186 * scrub or repair setup routine, and only prior to grabbing a transaction. 187 */ 188 static inline int 189 xchk_iget_safe(struct xfs_scrub *sc, xfs_ino_t inum, struct xfs_inode **ipp) 190 { 191 int error; 192 193 ASSERT(sc->tp == NULL); 194 195 error = xchk_trans_alloc(sc, 0); 196 if (error) 197 return error; 198 error = xchk_iget(sc, inum, ipp); 199 xchk_trans_cancel(sc); 200 return error; 201 } 202 203 /* 204 * Don't bother cross-referencing if we already found corruption or cross 205 * referencing discrepancies. 206 */ 207 static inline bool xchk_skip_xref(struct xfs_scrub_metadata *sm) 208 { 209 return sm->sm_flags & (XFS_SCRUB_OFLAG_CORRUPT | 210 XFS_SCRUB_OFLAG_XCORRUPT); 211 } 212 213 bool xchk_dir_looks_zapped(struct xfs_inode *dp); 214 215 #ifdef CONFIG_XFS_ONLINE_REPAIR 216 /* Decide if a repair is required. */ 217 static inline bool xchk_needs_repair(const struct xfs_scrub_metadata *sm) 218 { 219 return sm->sm_flags & (XFS_SCRUB_OFLAG_CORRUPT | 220 XFS_SCRUB_OFLAG_XCORRUPT | 221 XFS_SCRUB_OFLAG_PREEN); 222 } 223 224 /* 225 * "Should we prepare for a repair?" 226 * 227 * Return true if the caller permits us to repair metadata and we're not 228 * setting up for a post-repair evaluation. 229 */ 230 static inline bool xchk_could_repair(const struct xfs_scrub *sc) 231 { 232 return (sc->sm->sm_flags & XFS_SCRUB_IFLAG_REPAIR) && 233 !(sc->flags & XREP_ALREADY_FIXED); 234 } 235 #else 236 # define xchk_needs_repair(sc) (false) 237 # define xchk_could_repair(sc) (false) 238 #endif /* CONFIG_XFS_ONLINE_REPAIR */ 239 240 int xchk_metadata_inode_forks(struct xfs_scrub *sc); 241 242 /* 243 * Helper macros to allocate and format xfile description strings. 244 * Callers must kfree the pointer returned. 245 */ 246 #define xchk_xfile_descr(sc, fmt, ...) \ 247 kasprintf(XCHK_GFP_FLAGS, "XFS (%s): " fmt, \ 248 (sc)->mp->m_super->s_id, ##__VA_ARGS__) 249 #define xchk_xfile_ag_descr(sc, fmt, ...) \ 250 kasprintf(XCHK_GFP_FLAGS, "XFS (%s): AG 0x%x " fmt, \ 251 (sc)->mp->m_super->s_id, \ 252 (sc)->sa.pag ? (sc)->sa.pag->pag_agno : (sc)->sm->sm_agno, \ 253 ##__VA_ARGS__) 254 #define xchk_xfile_ino_descr(sc, fmt, ...) \ 255 kasprintf(XCHK_GFP_FLAGS, "XFS (%s): inode 0x%llx " fmt, \ 256 (sc)->mp->m_super->s_id, \ 257 (sc)->ip ? (sc)->ip->i_ino : (sc)->sm->sm_ino, \ 258 ##__VA_ARGS__) 259 260 /* 261 * Setting up a hook to wait for intents to drain is costly -- we have to take 262 * the CPU hotplug lock and force an i-cache flush on all CPUs once to set it 263 * up, and again to tear it down. These costs add up quickly, so we only want 264 * to enable the drain waiter if the drain actually detected a conflict with 265 * running intent chains. 266 */ 267 static inline bool xchk_need_intent_drain(struct xfs_scrub *sc) 268 { 269 return sc->flags & XCHK_NEED_DRAIN; 270 } 271 272 void xchk_fsgates_enable(struct xfs_scrub *sc, unsigned int scrub_fshooks); 273 274 int xchk_inode_is_allocated(struct xfs_scrub *sc, xfs_agino_t agino, 275 bool *inuse); 276 277 #endif /* __XFS_SCRUB_COMMON_H__ */ 278