1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Copyright (c) 2000-2005 Silicon Graphics, Inc. 4 * Copyright (c) 2013 Red Hat, Inc. 5 * All Rights Reserved. 6 */ 7 #ifndef __XFS_SHARED_H__ 8 #define __XFS_SHARED_H__ 9 10 /* 11 * Definitions shared between kernel and userspace that don't fit into any other 12 * header file that is shared with userspace. 13 */ 14 struct xfs_ifork; 15 struct xfs_buf; 16 struct xfs_buf_ops; 17 struct xfs_mount; 18 struct xfs_trans; 19 struct xfs_inode; 20 21 /* 22 * Buffer verifier operations are widely used, including userspace tools 23 */ 24 extern const struct xfs_buf_ops xfs_agf_buf_ops; 25 extern const struct xfs_buf_ops xfs_agfl_buf_ops; 26 extern const struct xfs_buf_ops xfs_agi_buf_ops; 27 extern const struct xfs_buf_ops xfs_attr3_leaf_buf_ops; 28 extern const struct xfs_buf_ops xfs_attr3_rmt_buf_ops; 29 extern const struct xfs_buf_ops xfs_bmbt_buf_ops; 30 extern const struct xfs_buf_ops xfs_bnobt_buf_ops; 31 extern const struct xfs_buf_ops xfs_cntbt_buf_ops; 32 extern const struct xfs_buf_ops xfs_da3_node_buf_ops; 33 extern const struct xfs_buf_ops xfs_dquot_buf_ops; 34 extern const struct xfs_buf_ops xfs_dquot_buf_ra_ops; 35 extern const struct xfs_buf_ops xfs_finobt_buf_ops; 36 extern const struct xfs_buf_ops xfs_inobt_buf_ops; 37 extern const struct xfs_buf_ops xfs_inode_buf_ops; 38 extern const struct xfs_buf_ops xfs_inode_buf_ra_ops; 39 extern const struct xfs_buf_ops xfs_refcountbt_buf_ops; 40 extern const struct xfs_buf_ops xfs_rmapbt_buf_ops; 41 extern const struct xfs_buf_ops xfs_rtbuf_ops; 42 extern const struct xfs_buf_ops xfs_sb_buf_ops; 43 extern const struct xfs_buf_ops xfs_sb_quiet_buf_ops; 44 extern const struct xfs_buf_ops xfs_symlink_buf_ops; 45 46 /* btree ops */ 47 extern const struct xfs_btree_ops xfs_bnobt_ops; 48 extern const struct xfs_btree_ops xfs_cntbt_ops; 49 extern const struct xfs_btree_ops xfs_inobt_ops; 50 extern const struct xfs_btree_ops xfs_finobt_ops; 51 extern const struct xfs_btree_ops xfs_bmbt_ops; 52 extern const struct xfs_btree_ops xfs_refcountbt_ops; 53 extern const struct xfs_btree_ops xfs_rmapbt_ops; 54 extern const struct xfs_btree_ops xfs_rmapbt_mem_ops; 55 xfs_btree_is_bno(const struct xfs_btree_ops * ops)56static inline bool xfs_btree_is_bno(const struct xfs_btree_ops *ops) 57 { 58 return ops == &xfs_bnobt_ops; 59 } 60 xfs_btree_is_cnt(const struct xfs_btree_ops * ops)61static inline bool xfs_btree_is_cnt(const struct xfs_btree_ops *ops) 62 { 63 return ops == &xfs_cntbt_ops; 64 } 65 xfs_btree_is_bmap(const struct xfs_btree_ops * ops)66static inline bool xfs_btree_is_bmap(const struct xfs_btree_ops *ops) 67 { 68 return ops == &xfs_bmbt_ops; 69 } 70 xfs_btree_is_ino(const struct xfs_btree_ops * ops)71static inline bool xfs_btree_is_ino(const struct xfs_btree_ops *ops) 72 { 73 return ops == &xfs_inobt_ops; 74 } 75 xfs_btree_is_fino(const struct xfs_btree_ops * ops)76static inline bool xfs_btree_is_fino(const struct xfs_btree_ops *ops) 77 { 78 return ops == &xfs_finobt_ops; 79 } 80 xfs_btree_is_refcount(const struct xfs_btree_ops * ops)81static inline bool xfs_btree_is_refcount(const struct xfs_btree_ops *ops) 82 { 83 return ops == &xfs_refcountbt_ops; 84 } 85 xfs_btree_is_rmap(const struct xfs_btree_ops * ops)86static inline bool xfs_btree_is_rmap(const struct xfs_btree_ops *ops) 87 { 88 return ops == &xfs_rmapbt_ops; 89 } 90 91 #ifdef CONFIG_XFS_BTREE_IN_MEM xfs_btree_is_mem_rmap(const struct xfs_btree_ops * ops)92static inline bool xfs_btree_is_mem_rmap(const struct xfs_btree_ops *ops) 93 { 94 return ops == &xfs_rmapbt_mem_ops; 95 } 96 #else 97 # define xfs_btree_is_mem_rmap(...) (false) 98 #endif 99 100 /* log size calculation functions */ 101 int xfs_log_calc_unit_res(struct xfs_mount *mp, int unit_bytes); 102 int xfs_log_calc_minimum_size(struct xfs_mount *); 103 104 struct xfs_trans_res; 105 void xfs_log_get_max_trans_res(struct xfs_mount *mp, 106 struct xfs_trans_res *max_resp); 107 108 /* 109 * Values for t_flags. 110 */ 111 /* Transaction needs to be logged */ 112 #define XFS_TRANS_DIRTY (1u << 0) 113 /* Superblock is dirty and needs to be logged */ 114 #define XFS_TRANS_SB_DIRTY (1u << 1) 115 /* Transaction took a permanent log reservation */ 116 #define XFS_TRANS_PERM_LOG_RES (1u << 2) 117 /* Synchronous transaction commit needed */ 118 #define XFS_TRANS_SYNC (1u << 3) 119 /* Transaction can use reserve block pool */ 120 #define XFS_TRANS_RESERVE (1u << 4) 121 /* Transaction should avoid VFS level superblock write accounting */ 122 #define XFS_TRANS_NO_WRITECOUNT (1u << 5) 123 /* Transaction has freed blocks returned to it's reservation */ 124 #define XFS_TRANS_RES_FDBLKS (1u << 6) 125 /* Transaction contains an intent done log item */ 126 #define XFS_TRANS_HAS_INTENT_DONE (1u << 7) 127 /* 128 * LOWMODE is used by the allocator to activate the lowspace algorithm - when 129 * free space is running low the extent allocator may choose to allocate an 130 * extent from an AG without leaving sufficient space for a btree split when 131 * inserting the new extent. In this case the allocator will enable the 132 * lowspace algorithm which is supposed to allow further allocations (such as 133 * btree splits and newroots) to allocate from sequential AGs. In order to 134 * avoid locking AGs out of order the lowspace algorithm will start searching 135 * for free space from AG 0. If the correct transaction reservations have been 136 * made then this algorithm will eventually find all the space it needs. 137 */ 138 #define XFS_TRANS_LOWMODE (1u << 8) 139 140 /* Transaction has locked the rtbitmap and rtsum inodes */ 141 #define XFS_TRANS_RTBITMAP_LOCKED (1u << 9) 142 143 /* 144 * Field values for xfs_trans_mod_sb. 145 */ 146 #define XFS_TRANS_SB_ICOUNT 0x00000001 147 #define XFS_TRANS_SB_IFREE 0x00000002 148 #define XFS_TRANS_SB_FDBLOCKS 0x00000004 149 #define XFS_TRANS_SB_RES_FDBLOCKS 0x00000008 150 #define XFS_TRANS_SB_FREXTENTS 0x00000010 151 #define XFS_TRANS_SB_RES_FREXTENTS 0x00000020 152 #define XFS_TRANS_SB_DBLOCKS 0x00000040 153 #define XFS_TRANS_SB_AGCOUNT 0x00000080 154 #define XFS_TRANS_SB_IMAXPCT 0x00000100 155 #define XFS_TRANS_SB_REXTSIZE 0x00000200 156 #define XFS_TRANS_SB_RBMBLOCKS 0x00000400 157 #define XFS_TRANS_SB_RBLOCKS 0x00000800 158 #define XFS_TRANS_SB_REXTENTS 0x00001000 159 #define XFS_TRANS_SB_REXTSLOG 0x00002000 160 161 /* 162 * Here we centralize the specification of XFS meta-data buffer reference count 163 * values. This determines how hard the buffer cache tries to hold onto the 164 * buffer. 165 */ 166 #define XFS_AGF_REF 4 167 #define XFS_AGI_REF 4 168 #define XFS_AGFL_REF 3 169 #define XFS_INO_BTREE_REF 3 170 #define XFS_ALLOC_BTREE_REF 2 171 #define XFS_BMAP_BTREE_REF 2 172 #define XFS_RMAP_BTREE_REF 2 173 #define XFS_DIR_BTREE_REF 2 174 #define XFS_INO_REF 2 175 #define XFS_ATTR_BTREE_REF 1 176 #define XFS_DQUOT_REF 1 177 #define XFS_REFC_BTREE_REF 1 178 #define XFS_SSB_REF 0 179 180 /* Computed inode geometry for the filesystem. */ 181 struct xfs_ino_geometry { 182 /* Maximum inode count in this filesystem. */ 183 uint64_t maxicount; 184 185 /* Actual inode cluster buffer size, in bytes. */ 186 unsigned int inode_cluster_size; 187 188 /* 189 * Desired inode cluster buffer size, in bytes. This value is not 190 * rounded up to at least one filesystem block, which is necessary for 191 * the sole purpose of validating sb_spino_align. Runtime code must 192 * only ever use inode_cluster_size. 193 */ 194 unsigned int inode_cluster_size_raw; 195 196 /* Inode cluster sizes, adjusted to be at least 1 fsb. */ 197 unsigned int inodes_per_cluster; 198 unsigned int blocks_per_cluster; 199 200 /* Inode cluster alignment. */ 201 unsigned int cluster_align; 202 unsigned int cluster_align_inodes; 203 unsigned int inoalign_mask; /* mask sb_inoalignmt if used */ 204 205 unsigned int inobt_mxr[2]; /* max inobt btree records */ 206 unsigned int inobt_mnr[2]; /* min inobt btree records */ 207 unsigned int inobt_maxlevels; /* max inobt btree levels. */ 208 209 /* Size of inode allocations under normal operation. */ 210 unsigned int ialloc_inos; 211 unsigned int ialloc_blks; 212 213 /* Minimum inode blocks for a sparse allocation. */ 214 unsigned int ialloc_min_blks; 215 216 /* stripe unit inode alignment */ 217 unsigned int ialloc_align; 218 219 unsigned int agino_log; /* #bits for agino in inum */ 220 221 /* precomputed default inode attribute fork offset */ 222 unsigned int attr_fork_offset; 223 224 /* precomputed value for di_flags2 */ 225 uint64_t new_diflags2; 226 227 /* minimum folio order of a page cache allocation */ 228 unsigned int min_folio_order; 229 230 }; 231 232 #endif /* __XFS_SHARED_H__ */ 233