// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Copyright (C) 2018-2023 Oracle.  All Rights Reserved.
 * Author: Darrick J. Wong <djwong@kernel.org>
 */
#ifndef __XFS_SCRUB_REPAIR_H__
#define __XFS_SCRUB_REPAIR_H__

#include "xfs_quota_defs.h"

struct xfs_rtgroup;
struct xchk_stats_run;

static inline int xrep_notsupported(struct xfs_scrub *sc)
{
        return -EOPNOTSUPP;
}

#ifdef CONFIG_XFS_ONLINE_REPAIR

/* Repair helpers */

int xrep_attempt(struct xfs_scrub *sc, struct xchk_stats_run *run);
bool xrep_will_attempt(struct xfs_scrub *sc);
void xrep_failure(struct xfs_mount *mp);
int xrep_roll_ag_trans(struct xfs_scrub *sc);
int xrep_roll_trans(struct xfs_scrub *sc);
int xrep_defer_finish(struct xfs_scrub *sc);
bool xrep_ag_has_space(struct xfs_perag *pag, xfs_extlen_t nr_blocks,
                enum xfs_ag_resv_type type);
xfs_extlen_t xrep_calc_ag_resblks(struct xfs_scrub *sc);

static inline int
xrep_trans_commit(
        struct xfs_scrub        *sc)
{
        int error = xfs_trans_commit(sc->tp);

        sc->tp = NULL;
        return error;
}

struct xbitmap;
struct xagb_bitmap;
struct xrgb_bitmap;
struct xfsb_bitmap;
struct xrtb_bitmap;

int xrep_fix_freelist(struct xfs_scrub *sc, int alloc_flags);

struct xrep_find_ag_btree {
        /* in: rmap owner of the btree we're looking for */
        uint64_t                        rmap_owner;

        /* in: buffer ops */
        const struct xfs_buf_ops        *buf_ops;

        /* in: maximum btree height */
        unsigned int                    maxlevels;

        /* out: the highest btree block found and the tree height */
        xfs_agblock_t                   root;
        unsigned int                    height;
};

int xrep_find_ag_btree_roots(struct xfs_scrub *sc, struct xfs_buf *agf_bp,
                struct xrep_find_ag_btree *btree_info, struct xfs_buf *agfl_bp);

#ifdef CONFIG_XFS_QUOTA
void xrep_update_qflags(struct xfs_scrub *sc, unsigned int clear_flags,
                unsigned int set_flags);
void xrep_force_quotacheck(struct xfs_scrub *sc, xfs_dqtype_t type);
int xrep_ino_dqattach(struct xfs_scrub *sc);
#else
# define xrep_force_quotacheck(sc, type)        ((void)0)
# define xrep_ino_dqattach(sc)                  (0)
#endif /* CONFIG_XFS_QUOTA */

int xrep_setup_xfbtree(struct xfs_scrub *sc, const char *descr);

int xrep_ino_ensure_extent_count(struct xfs_scrub *sc, int whichfork,
                xfs_extnum_t nextents);
int xrep_reset_perag_resv(struct xfs_scrub *sc);
int xrep_bmap(struct xfs_scrub *sc, int whichfork, bool allow_unwritten);
int xrep_metadata_inode_forks(struct xfs_scrub *sc);
int xrep_setup_ag_rmapbt(struct xfs_scrub *sc);
int xrep_setup_ag_refcountbt(struct xfs_scrub *sc);
int xrep_setup_xattr(struct xfs_scrub *sc);
int xrep_setup_directory(struct xfs_scrub *sc);
int xrep_setup_parent(struct xfs_scrub *sc);
int xrep_setup_nlinks(struct xfs_scrub *sc);
int xrep_setup_symlink(struct xfs_scrub *sc, unsigned int *resblks);
int xrep_setup_dirtree(struct xfs_scrub *sc);
int xrep_setup_rtrmapbt(struct xfs_scrub *sc);
int xrep_setup_rtrefcountbt(struct xfs_scrub *sc);

/* Repair setup functions */
int xrep_setup_ag_allocbt(struct xfs_scrub *sc);

struct xfs_imap;
int xrep_setup_inode(struct xfs_scrub *sc, const struct xfs_imap *imap);

void xrep_ag_btcur_init(struct xfs_scrub *sc, struct xchk_ag *sa);
int xrep_ag_init(struct xfs_scrub *sc, struct xfs_perag *pag,
                struct xchk_ag *sa);
#ifdef CONFIG_XFS_RT
int xrep_rtgroup_init(struct xfs_scrub *sc, struct xfs_rtgroup *rtg,
                struct xchk_rt *sr, unsigned int rtglock_flags);
void xrep_rtgroup_btcur_init(struct xfs_scrub *sc, struct xchk_rt *sr);
int xrep_require_rtext_inuse(struct xfs_scrub *sc, xfs_rgblock_t rgbno,
                xfs_filblks_t len);
xfs_extlen_t xrep_calc_rtgroup_resblks(struct xfs_scrub *sc);
#else
# define xrep_rtgroup_init(sc, rtg, sr, lockflags)      (-ENOSYS)
# define xrep_calc_rtgroup_resblks(sc)                  (0)
#endif /* CONFIG_XFS_RT */

int xrep_check_ino_btree_mapping(struct xfs_scrub *sc,
                const struct xfs_rmap_irec *rec);

/* Metadata revalidators */

int xrep_revalidate_allocbt(struct xfs_scrub *sc);
int xrep_revalidate_iallocbt(struct xfs_scrub *sc);

/* Metadata repairers */

int xrep_probe(struct xfs_scrub *sc);
int xrep_superblock(struct xfs_scrub *sc);
int xrep_agf(struct xfs_scrub *sc);
int xrep_agfl(struct xfs_scrub *sc);
int xrep_agi(struct xfs_scrub *sc);
int xrep_allocbt(struct xfs_scrub *sc);
int xrep_iallocbt(struct xfs_scrub *sc);
int xrep_rmapbt(struct xfs_scrub *sc);
int xrep_refcountbt(struct xfs_scrub *sc);
int xrep_inode(struct xfs_scrub *sc);
int xrep_bmap_data(struct xfs_scrub *sc);
int xrep_bmap_attr(struct xfs_scrub *sc);
int xrep_bmap_cow(struct xfs_scrub *sc);
int xrep_nlinks(struct xfs_scrub *sc);
int xrep_fscounters(struct xfs_scrub *sc);
int xrep_xattr(struct xfs_scrub *sc);
int xrep_directory(struct xfs_scrub *sc);
int xrep_parent(struct xfs_scrub *sc);
int xrep_symlink(struct xfs_scrub *sc);
int xrep_dirtree(struct xfs_scrub *sc);
int xrep_metapath(struct xfs_scrub *sc);

#ifdef CONFIG_XFS_RT
int xrep_rtbitmap(struct xfs_scrub *sc);
int xrep_rtsummary(struct xfs_scrub *sc);
int xrep_rgsuperblock(struct xfs_scrub *sc);
int xrep_rtrmapbt(struct xfs_scrub *sc);
int xrep_rtrefcountbt(struct xfs_scrub *sc);
#else
# define xrep_rtbitmap                  xrep_notsupported
# define xrep_rtsummary                 xrep_notsupported
# define xrep_rgsuperblock              xrep_notsupported
# define xrep_rtrmapbt                  xrep_notsupported
# define xrep_rtrefcountbt              xrep_notsupported
#endif /* CONFIG_XFS_RT */

#ifdef CONFIG_XFS_QUOTA
int xrep_quota(struct xfs_scrub *sc);
int xrep_quotacheck(struct xfs_scrub *sc);
#else
# define xrep_quota                     xrep_notsupported
# define xrep_quotacheck                xrep_notsupported
#endif /* CONFIG_XFS_QUOTA */

int xrep_reinit_pagf(struct xfs_scrub *sc);
int xrep_reinit_pagi(struct xfs_scrub *sc);

bool xrep_buf_verify_struct(struct xfs_buf *bp, const struct xfs_buf_ops *ops);
void xrep_inode_set_nblocks(struct xfs_scrub *sc, int64_t new_blocks);
int xrep_reset_metafile_resv(struct xfs_scrub *sc);

#else

#define xrep_ino_dqattach(sc)   (0)

/*
 * When online repair is not built into the kernel, we still want to attempt
 * the repair so that the stub xrep_attempt below will return EOPNOTSUPP.
 */
static inline bool xrep_will_attempt(const struct xfs_scrub *sc)
{
        return (sc->sm->sm_flags & XFS_SCRUB_IFLAG_FORCE_REBUILD) ||
                xchk_needs_repair(sc->sm);
}

static inline int
xrep_attempt(
        struct xfs_scrub        *sc,
        struct xchk_stats_run   *run)
{
        return -EOPNOTSUPP;
}

static inline void xrep_failure(struct xfs_mount *mp) {}

static inline xfs_extlen_t
xrep_calc_ag_resblks(
        struct xfs_scrub        *sc)
{
        return 0;
}

#define xrep_calc_rtgroup_resblks       xrep_calc_ag_resblks

static inline int
xrep_reset_perag_resv(
        struct xfs_scrub        *sc)
{
        if (!(sc->flags & XREP_RESET_PERAG_RESV))
                return 0;

        ASSERT(0);
        return -EOPNOTSUPP;
}

/* repair setup functions for no-repair */
static inline int
xrep_setup_nothing(
        struct xfs_scrub        *sc)
{
        return 0;
}
#define xrep_setup_ag_allocbt           xrep_setup_nothing
#define xrep_setup_ag_rmapbt            xrep_setup_nothing
#define xrep_setup_ag_refcountbt        xrep_setup_nothing
#define xrep_setup_xattr                xrep_setup_nothing
#define xrep_setup_directory            xrep_setup_nothing
#define xrep_setup_parent               xrep_setup_nothing
#define xrep_setup_nlinks               xrep_setup_nothing
#define xrep_setup_dirtree              xrep_setup_nothing
#define xrep_setup_metapath             xrep_setup_nothing
#define xrep_setup_rtrmapbt             xrep_setup_nothing
#define xrep_setup_rtrefcountbt         xrep_setup_nothing

#define xrep_setup_inode(sc, imap)      ((void)0)

static inline int xrep_setup_symlink(struct xfs_scrub *sc, unsigned int *x)
{
        return 0;
}

#define xrep_revalidate_allocbt         (NULL)
#define xrep_revalidate_iallocbt        (NULL)

#define xrep_probe                      xrep_notsupported
#define xrep_superblock                 xrep_notsupported
#define xrep_agf                        xrep_notsupported
#define xrep_agfl                       xrep_notsupported
#define xrep_agi                        xrep_notsupported
#define xrep_allocbt                    xrep_notsupported
#define xrep_iallocbt                   xrep_notsupported
#define xrep_rmapbt                     xrep_notsupported
#define xrep_refcountbt                 xrep_notsupported
#define xrep_inode                      xrep_notsupported
#define xrep_bmap_data                  xrep_notsupported
#define xrep_bmap_attr                  xrep_notsupported
#define xrep_bmap_cow                   xrep_notsupported
#define xrep_rtbitmap                   xrep_notsupported
#define xrep_quota                      xrep_notsupported
#define xrep_quotacheck                 xrep_notsupported
#define xrep_nlinks                     xrep_notsupported
#define xrep_fscounters                 xrep_notsupported
#define xrep_rtsummary                  xrep_notsupported
#define xrep_xattr                      xrep_notsupported
#define xrep_directory                  xrep_notsupported
#define xrep_parent                     xrep_notsupported
#define xrep_symlink                    xrep_notsupported
#define xrep_dirtree                    xrep_notsupported
#define xrep_metapath                   xrep_notsupported
#define xrep_rgsuperblock               xrep_notsupported
#define xrep_rtrmapbt                   xrep_notsupported
#define xrep_rtrefcountbt               xrep_notsupported

#endif /* CONFIG_XFS_ONLINE_REPAIR */

#endif  /* __XFS_SCRUB_REPAIR_H__ */