// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
 * All Rights Reserved.
 */
#ifndef __XFS_TYPES_H__
#define __XFS_TYPES_H__

typedef uint32_t        prid_t;         /* project ID */

typedef uint32_t        xfs_agblock_t;  /* blockno in alloc. group */
typedef uint32_t        xfs_rgblock_t;  /* blockno in realtime group */
typedef uint32_t        xfs_agino_t;    /* inode # within allocation grp */
typedef uint32_t        xfs_extlen_t;   /* extent length in blocks */
typedef uint32_t        xfs_rtxlen_t;   /* file extent length in rtextents */
typedef uint32_t        xfs_agnumber_t; /* allocation group number */
typedef uint32_t        xfs_rgnumber_t; /* realtime group number */
typedef uint64_t        xfs_extnum_t;   /* # of extents in a file */
typedef uint32_t        xfs_aextnum_t;  /* # extents in an attribute fork */
typedef int64_t         xfs_fsize_t;    /* bytes in a file */
typedef uint64_t        xfs_ufsize_t;   /* unsigned bytes in a file */

typedef int32_t         xfs_suminfo_t;  /* type of bitmap summary info */
typedef uint32_t        xfs_rtsumoff_t; /* offset of an rtsummary info word */
typedef uint32_t        xfs_rtword_t;   /* word type for bitmap manipulations */

typedef int64_t         xfs_lsn_t;      /* log sequence number */
typedef int64_t         xfs_csn_t;      /* CIL sequence number */

typedef uint32_t        xfs_dablk_t;    /* dir/attr block number (in file) */
typedef uint32_t        xfs_dahash_t;   /* dir/attr hash value */

typedef uint64_t        xfs_fsblock_t;  /* blockno in filesystem (agno|agbno) */
typedef uint64_t        xfs_rfsblock_t; /* blockno in filesystem (raw) */
typedef uint64_t        xfs_rtblock_t;  /* extent (block) in realtime area */
typedef uint64_t        xfs_fileoff_t;  /* block number in a file */
typedef uint64_t        xfs_filblks_t;  /* number of blocks in a file */
typedef uint64_t        xfs_rtxnum_t;   /* rtextent number */
typedef uint64_t        xfs_rtbxlen_t;  /* rtbitmap extent length in rtextents */

typedef int64_t         xfs_srtblock_t; /* signed version of xfs_rtblock_t */

/*
 * New verifiers will return the instruction address of the failing check.
 * NULL means everything is ok.
 */
typedef void *          xfs_failaddr_t;

/*
 * Null values for the types.
 */
#define NULLFSBLOCK     ((xfs_fsblock_t)-1)
#define NULLRFSBLOCK    ((xfs_rfsblock_t)-1)
#define NULLRTBLOCK     ((xfs_rtblock_t)-1)
#define NULLFILEOFF     ((xfs_fileoff_t)-1)

#define NULLAGBLOCK     ((xfs_agblock_t)-1)
#define NULLRGBLOCK     ((xfs_rgblock_t)-1)
#define NULLAGNUMBER    ((xfs_agnumber_t)-1)
#define NULLRGNUMBER    ((xfs_rgnumber_t)-1)

#define NULLCOMMITLSN   ((xfs_lsn_t)-1)

#define NULLFSINO       ((xfs_ino_t)-1)
#define NULLAGINO       ((xfs_agino_t)-1)

/*
 * Minimum and maximum blocksize and sectorsize.
 * The blocksize upper limit is pretty much arbitrary.
 * The sectorsize upper limit is due to sizeof(sb_sectsize).
 * CRC enable filesystems use 512 byte inodes, meaning 512 byte block sizes
 * cannot be used.
 */
#define XFS_MIN_BLOCKSIZE_LOG   9       /* i.e. 512 bytes */
#define XFS_MAX_BLOCKSIZE_LOG   16      /* i.e. 65536 bytes */
#define XFS_MIN_BLOCKSIZE       (1 << XFS_MIN_BLOCKSIZE_LOG)
#define XFS_MAX_BLOCKSIZE       (1 << XFS_MAX_BLOCKSIZE_LOG)
#define XFS_MIN_CRC_BLOCKSIZE   (1 << (XFS_MIN_BLOCKSIZE_LOG + 1))
#define XFS_MIN_SECTORSIZE_LOG  9       /* i.e. 512 bytes */
#define XFS_MAX_SECTORSIZE_LOG  15      /* i.e. 32768 bytes */
#define XFS_MIN_SECTORSIZE      (1 << XFS_MIN_SECTORSIZE_LOG)
#define XFS_MAX_SECTORSIZE      (1 << XFS_MAX_SECTORSIZE_LOG)

/*
 * Inode fork identifiers.
 */
#define XFS_STAGING_FORK        (-1)    /* fake fork for staging a btree */
#define XFS_DATA_FORK           (0)
#define XFS_ATTR_FORK           (1)
#define XFS_COW_FORK            (2)

#define XFS_WHICHFORK_STRINGS \
        { XFS_STAGING_FORK,     "staging" }, \
        { XFS_DATA_FORK,        "data" }, \
        { XFS_ATTR_FORK,        "attr" }, \
        { XFS_COW_FORK,         "cow" }

/*
 * Min numbers of data/attr fork btree root pointers.
 */
#define MINDBTPTRS      3
#define MINABTPTRS      2

/*
 * MAXNAMELEN is the length (including the terminating null) of
 * the longest permissible file (component) name.
 */
#define MAXNAMELEN      256

/*
 * This enum is used in string mapping in xfs_trace.h; please keep the
 * TRACE_DEFINE_ENUMs for it up to date.
 */
typedef enum {
        XFS_LOOKUP_EQi, XFS_LOOKUP_LEi, XFS_LOOKUP_GEi
} xfs_lookup_t;

#define XFS_AG_BTREE_CMP_FORMAT_STR \
        { XFS_LOOKUP_EQi,       "eq" }, \
        { XFS_LOOKUP_LEi,       "le" }, \
        { XFS_LOOKUP_GEi,       "ge" }

struct xfs_name {
        const unsigned char     *name;
        int                     len;
        int                     type;
};

/*
 * uid_t and gid_t are hard-coded to 32 bits in the inode.
 * Hence, an 'id' in a dquot is 32 bits..
 */
typedef uint32_t        xfs_dqid_t;

/*
 * Constants for bit manipulations.
 */
#define XFS_NBBYLOG     3               /* log2(NBBY) */
#define XFS_WORDLOG     2               /* log2(sizeof(xfs_rtword_t)) */
#define XFS_SUMINFOLOG  2               /* log2(sizeof(xfs_suminfo_t)) */
#define XFS_NBWORDLOG   (XFS_NBBYLOG + XFS_WORDLOG)
#define XFS_NBWORD      (1 << XFS_NBWORDLOG)
#define XFS_WORDMASK    ((1 << XFS_WORDLOG) - 1)

struct xfs_iext_cursor {
        struct xfs_iext_leaf    *leaf;
        int                     pos;
};

typedef enum {
        XFS_EXT_NORM, XFS_EXT_UNWRITTEN,
} xfs_exntst_t;

typedef struct xfs_bmbt_irec
{
        xfs_fileoff_t   br_startoff;    /* starting file offset */
        xfs_fsblock_t   br_startblock;  /* starting block number */
        xfs_filblks_t   br_blockcount;  /* number of blocks */
        xfs_exntst_t    br_state;       /* extent state */
} xfs_bmbt_irec_t;

enum xfs_refc_domain {
        XFS_REFC_DOMAIN_SHARED = 0,
        XFS_REFC_DOMAIN_COW,
};

#define XFS_REFC_DOMAIN_STRINGS \
        { XFS_REFC_DOMAIN_SHARED,       "shared" }, \
        { XFS_REFC_DOMAIN_COW,          "cow" }

struct xfs_refcount_irec {
        xfs_agblock_t   rc_startblock;  /* starting block number */
        xfs_extlen_t    rc_blockcount;  /* count of free blocks */
        xfs_nlink_t     rc_refcount;    /* number of inodes linked here */
        enum xfs_refc_domain    rc_domain; /* shared or cow staging extent? */
};

#define XFS_RMAP_ATTR_FORK              (1 << 0)
#define XFS_RMAP_BMBT_BLOCK             (1 << 1)
#define XFS_RMAP_UNWRITTEN              (1 << 2)
#define XFS_RMAP_KEY_FLAGS              (XFS_RMAP_ATTR_FORK | \
                                         XFS_RMAP_BMBT_BLOCK)
#define XFS_RMAP_REC_FLAGS              (XFS_RMAP_UNWRITTEN)
struct xfs_rmap_irec {
        xfs_agblock_t   rm_startblock;  /* extent start block */
        xfs_extlen_t    rm_blockcount;  /* extent length */
        uint64_t        rm_owner;       /* extent owner */
        uint64_t        rm_offset;      /* offset within the owner */
        unsigned int    rm_flags;       /* state flags */
};

/* per-AG block reservation types */
enum xfs_ag_resv_type {
        XFS_AG_RESV_NONE = 0,
        XFS_AG_RESV_AGFL,
        XFS_AG_RESV_METADATA,
        XFS_AG_RESV_RMAPBT,

        /*
         * Don't increase fdblocks when freeing extent.  This is a pony for
         * the bnobt repair functions to re-free the free space without
         * altering fdblocks.  If you think you need this you're wrong.
         */
        XFS_AG_RESV_IGNORE,

        /*
         * This allocation activity is being done on behalf of a metadata file.
         * These files maintain their own permanent space reservations and are
         * required to adjust fdblocks using the xfs_metafile_resv_* helpers.
         */
        XFS_AG_RESV_METAFILE,
};

/* Results of scanning a btree keyspace to check occupancy. */
enum xbtree_recpacking {
        /* None of the keyspace maps to records. */
        XBTREE_RECPACKING_EMPTY = 0,

        /* Some, but not all, of the keyspace maps to records. */
        XBTREE_RECPACKING_SPARSE,

        /* The entire keyspace maps to records. */
        XBTREE_RECPACKING_FULL,
};

enum xfs_group_type {
        XG_TYPE_AG,
        XG_TYPE_RTG,
        XG_TYPE_MAX,
} __packed;

#define XG_TYPE_STRINGS \
        { XG_TYPE_AG,   "ag" }, \
        { XG_TYPE_RTG,  "rtg" }

enum xfs_free_counter {
        /*
         * Number of free blocks on the data device.
         */
        XC_FREE_BLOCKS,

        /*
         * Number of free RT extents on the RT device.
         */
        XC_FREE_RTEXTENTS,

        /*
         * Number of available for use RT extents.
         *
         * This counter only exists for zoned RT device and indicates the number
         * of RT extents that can be directly used by writes.  XC_FREE_RTEXTENTS
         * also includes blocks that have been written previously and freed, but
         * sit in a rtgroup that still needs a zone reset.
         */
        XC_FREE_RTAVAILABLE,
        XC_FREE_NR,
};

#define XFS_FREECOUNTER_STR \
        { XC_FREE_BLOCKS,               "blocks" }, \
        { XC_FREE_RTEXTENTS,            "rtextents" }, \
        { XC_FREE_RTAVAILABLE,          "rtavailable" }

/*
 * Type verifier functions
 */
struct xfs_mount;

bool xfs_verify_fsbno(struct xfs_mount *mp, xfs_fsblock_t fsbno);
bool xfs_verify_fsbext(struct xfs_mount *mp, xfs_fsblock_t fsbno,
                xfs_fsblock_t len);

bool xfs_verify_ino(struct xfs_mount *mp, xfs_ino_t ino);
bool xfs_is_sb_inum(struct xfs_mount *mp, xfs_ino_t ino);
bool xfs_verify_dir_ino(struct xfs_mount *mp, xfs_ino_t ino);
bool xfs_verify_rtbno(struct xfs_mount *mp, xfs_rtblock_t rtbno);
bool xfs_verify_rtbext(struct xfs_mount *mp, xfs_rtblock_t rtbno,
                xfs_filblks_t len);
bool xfs_verify_icount(struct xfs_mount *mp, unsigned long long icount);
bool xfs_verify_dablk(struct xfs_mount *mp, xfs_fileoff_t off);
void xfs_icount_range(struct xfs_mount *mp, unsigned long long *min,
                unsigned long long *max);
bool xfs_verify_fileoff(struct xfs_mount *mp, xfs_fileoff_t off);
bool xfs_verify_fileext(struct xfs_mount *mp, xfs_fileoff_t off,
                xfs_fileoff_t len);

#endif  /* __XFS_TYPES_H__ */