linux/fs/xfs/libxfs/xfs_shared.h

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

/*
 * Definitions shared between kernel and userspace that don't fit into any other
 * header file that is shared with userspace.
 */
struct xfs_ifork;
struct xfs_buf;
struct xfs_buf_ops;
struct xfs_mount;
struct xfs_trans;
struct xfs_inode;

/*
 * Buffer verifier operations are widely used, including userspace tools
 */
extern const struct xfs_buf_ops xfs_agf_buf_ops;
extern const struct xfs_buf_ops xfs_agfl_buf_ops;
extern const struct xfs_buf_ops xfs_agi_buf_ops;
extern const struct xfs_buf_ops xfs_attr3_leaf_buf_ops;
extern const struct xfs_buf_ops xfs_attr3_rmt_buf_ops;
extern const struct xfs_buf_ops xfs_bmbt_buf_ops;
extern const struct xfs_buf_ops xfs_bnobt_buf_ops;
extern const struct xfs_buf_ops xfs_cntbt_buf_ops;
extern const struct xfs_buf_ops xfs_da3_node_buf_ops;
extern const struct xfs_buf_ops xfs_dquot_buf_ops;
extern const struct xfs_buf_ops xfs_dquot_buf_ra_ops;
extern const struct xfs_buf_ops xfs_finobt_buf_ops;
extern const struct xfs_buf_ops xfs_inobt_buf_ops;
extern const struct xfs_buf_ops xfs_inode_buf_ops;
extern const struct xfs_buf_ops xfs_inode_buf_ra_ops;
extern const struct xfs_buf_ops xfs_refcountbt_buf_ops;
extern const struct xfs_buf_ops xfs_rmapbt_buf_ops;
extern const struct xfs_buf_ops xfs_rtbuf_ops;
extern const struct xfs_buf_ops xfs_sb_buf_ops;
extern const struct xfs_buf_ops xfs_sb_quiet_buf_ops;
extern const struct xfs_buf_ops xfs_symlink_buf_ops;

/* btree ops */
extern const struct xfs_btree_ops xfs_bnobt_ops;
extern const struct xfs_btree_ops xfs_cntbt_ops;
extern const struct xfs_btree_ops xfs_inobt_ops;
extern const struct xfs_btree_ops xfs_finobt_ops;
extern const struct xfs_btree_ops xfs_bmbt_ops;
extern const struct xfs_btree_ops xfs_refcountbt_ops;
extern const struct xfs_btree_ops xfs_rmapbt_ops;
extern const struct xfs_btree_ops xfs_rmapbt_mem_ops;

static inline bool xfs_btree_is_bno(const struct xfs_btree_ops *ops)
{}

static inline bool xfs_btree_is_cnt(const struct xfs_btree_ops *ops)
{}

static inline bool xfs_btree_is_bmap(const struct xfs_btree_ops *ops)
{}

static inline bool xfs_btree_is_ino(const struct xfs_btree_ops *ops)
{}

static inline bool xfs_btree_is_fino(const struct xfs_btree_ops *ops)
{}

static inline bool xfs_btree_is_refcount(const struct xfs_btree_ops *ops)
{}

static inline bool xfs_btree_is_rmap(const struct xfs_btree_ops *ops)
{}

#ifdef CONFIG_XFS_BTREE_IN_MEM
static inline bool xfs_btree_is_mem_rmap(const struct xfs_btree_ops *ops)
{}
#else
#define xfs_btree_is_mem_rmap
#endif

/* log size calculation functions */
int	xfs_log_calc_unit_res(struct xfs_mount *mp, int unit_bytes);
int	xfs_log_calc_minimum_size(struct xfs_mount *);

struct xfs_trans_res;
void	xfs_log_get_max_trans_res(struct xfs_mount *mp,
				  struct xfs_trans_res *max_resp);

/*
 * Values for t_flags.
 */
/* Transaction needs to be logged */
#define XFS_TRANS_DIRTY
/* Superblock is dirty and needs to be logged */
#define XFS_TRANS_SB_DIRTY
/* Transaction took a permanent log reservation */
#define XFS_TRANS_PERM_LOG_RES
/* Synchronous transaction commit needed */
#define XFS_TRANS_SYNC
/* Transaction can use reserve block pool */
#define XFS_TRANS_RESERVE
/* Transaction should avoid VFS level superblock write accounting */
#define XFS_TRANS_NO_WRITECOUNT
/* Transaction has freed blocks returned to it's reservation */
#define XFS_TRANS_RES_FDBLKS
/* Transaction contains an intent done log item */
#define XFS_TRANS_HAS_INTENT_DONE
/*
 * LOWMODE is used by the allocator to activate the lowspace algorithm - when
 * free space is running low the extent allocator may choose to allocate an
 * extent from an AG without leaving sufficient space for a btree split when
 * inserting the new extent. In this case the allocator will enable the
 * lowspace algorithm which is supposed to allow further allocations (such as
 * btree splits and newroots) to allocate from sequential AGs. In order to
 * avoid locking AGs out of order the lowspace algorithm will start searching
 * for free space from AG 0. If the correct transaction reservations have been
 * made then this algorithm will eventually find all the space it needs.
 */
#define XFS_TRANS_LOWMODE

/* Transaction has locked the rtbitmap and rtsum inodes */
#define XFS_TRANS_RTBITMAP_LOCKED

/*
 * Field values for xfs_trans_mod_sb.
 */
#define XFS_TRANS_SB_ICOUNT
#define XFS_TRANS_SB_IFREE
#define XFS_TRANS_SB_FDBLOCKS
#define XFS_TRANS_SB_RES_FDBLOCKS
#define XFS_TRANS_SB_FREXTENTS
#define XFS_TRANS_SB_RES_FREXTENTS
#define XFS_TRANS_SB_DBLOCKS
#define XFS_TRANS_SB_AGCOUNT
#define XFS_TRANS_SB_IMAXPCT
#define XFS_TRANS_SB_REXTSIZE
#define XFS_TRANS_SB_RBMBLOCKS
#define XFS_TRANS_SB_RBLOCKS
#define XFS_TRANS_SB_REXTENTS
#define XFS_TRANS_SB_REXTSLOG

/*
 * Here we centralize the specification of XFS meta-data buffer reference count
 * values.  This determines how hard the buffer cache tries to hold onto the
 * buffer.
 */
#define XFS_AGF_REF
#define XFS_AGI_REF
#define XFS_AGFL_REF
#define XFS_INO_BTREE_REF
#define XFS_ALLOC_BTREE_REF
#define XFS_BMAP_BTREE_REF
#define XFS_RMAP_BTREE_REF
#define XFS_DIR_BTREE_REF
#define XFS_INO_REF
#define XFS_ATTR_BTREE_REF
#define XFS_DQUOT_REF
#define XFS_REFC_BTREE_REF
#define XFS_SSB_REF

/* Computed inode geometry for the filesystem. */
struct xfs_ino_geometry {};

#endif /* __XFS_SHARED_H__ */